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(*): update deprecated comments, contributing guide; fix tags #14008

Merged
merged 9 commits into from Apr 5, 2024

Conversation

damyanpetev
Copy link
Member

@damyanpetev damyanpetev commented Mar 22, 2024

We've been doing the @deprecated JSDoc tags wrong, since almost all tags are block so placing them on the top of the comment description consumes it as well as part of the tag:
image
So I've updated all the comments and adjusted the Contributing Guidelines accordingly.

Also found a widespread use of @Input in the comments as a tag (without backticks) which breaks the comments further:
image
and removed all of those uses. If we still want to additional meta for that property in the API Docs, that can be either automated or the new signal inputs will likely force it anyway from the different return type if/when we start using them.

Bonus: Mainly due to some spelling errors, adding the following as VS Code recommendations for extensions in the project:

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

Checklist:

  • All relevant tags have been applied to this PR
  • This PR includes unit tests covering all the new code (test guidelines)
  • This PR includes API docs for newly added methods/properties (api docs guidelines)
  • This PR includes feature/README.MD updates for the feature docs
  • This PR includes general feature table updates in the root README.MD
  • This PR includes CHANGELOG.MD updates for newly added functionality
  • This PR contains breaking changes
  • This PR includes ng update migrations for the breaking changes (migrations guidelines)
  • This PR includes behavioral changes and the feature specification has been updated with them

@damyanpetev damyanpetev force-pushed the dpetev/deprecated-contributing branch from 656c729 to 6b70096 Compare March 22, 2024 12:46
@damyanpetev damyanpetev requested a review from kdinev April 5, 2024 08:29
@damyanpetev damyanpetev changed the title Update deprecated comments & contributing guide, fix invalid tag docs(*): update deprecated comments, contributing guide; fix tags Apr 5, 2024
@damyanpetev damyanpetev added the squash-merge Merge PR with "Squash and Merge" option label Apr 5, 2024
@kdinev kdinev merged commit 72188e9 into master Apr 5, 2024
5 of 7 checks passed
@kdinev kdinev deleted the dpetev/deprecated-contributing branch April 5, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation squash-merge Merge PR with "Squash and Merge" option typedoc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants