Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: extends validation error and validation error items explanation #13815

Closed
wants to merge 3 commits into from

Conversation

fzn0x
Copy link
Member

@fzn0x fzn0x commented Dec 23, 2021

Pull Request Checklist

Please make sure to review and check all of these items:

  • Have you added new tests to prevent regressions?
  • Does npm run test or npm run test-DIALECT pass with this change (including linting)?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Did you update the typescript typings accordingly (if applicable)?
  • Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
  • Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description Of Change

Closes #13812

Todos

  • Fix unnecessary block tags in ValidationError class multiline comment
  • Expand validation error item parameters

@fzn0x fzn0x added type: refactor For issues and PRs. Things that improve the code readability, maintainability, testability, etc. type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference. labels Dec 23, 2021
@fzn0x fzn0x self-assigned this Dec 23, 2021
@fzn0x fzn0x requested a review from sdepold December 23, 2021 13:14
lib/errors/validation-error.ts Show resolved Hide resolved
lib/errors/validation-error.ts Show resolved Hide resolved
lib/errors/validation-error.ts Show resolved Hide resolved
@fzn0x
Copy link
Member Author

fzn0x commented Jan 13, 2022

Change it to draft since it's depends on Docusaurus PR. #13769

@WikiRik
Copy link
Member

WikiRik commented Apr 5, 2022

@fzn0x do you want to reopen this?

@ephys
Copy link
Member

ephys commented Apr 6, 2022

All changes are already included thanks to Typedoc properly extracting the information from the jsdoc (which esdoc failed to do), and I think #14002

@fzn0x if you confirm, can you delete the unmerged branch?

@fzn0x fzn0x deleted the docs/validation-error branch April 15, 2022 20:33
@fzn0x
Copy link
Member Author

fzn0x commented Apr 15, 2022

Removed, thanks @sdepold @WikiRik @ephys :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference. type: refactor For issues and PRs. Things that improve the code readability, maintainability, testability, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand on ValidationErrorItem
3 participants