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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
damyanpetev
force-pushed
the
dpetev/deprecated-contributing
branch
from
March 22, 2024 12:46
656c729
to
6b70096
Compare
kdinev
requested changes
Mar 26, 2024
projects/igniteui-angular/src/lib/action-strip/action-strip.component.ts
Outdated
Show resolved
Hide resolved
projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts
Outdated
Show resolved
Hide resolved
projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts
Outdated
Show resolved
Hide resolved
projects/igniteui-angular/src/lib/drop-down/drop-down.component.ts
Outdated
Show resolved
Hide resolved
...ui-angular/src/lib/grids/filtering/advanced-filtering/advanced-filtering-dialog.component.ts
Outdated
Show resolved
Hide resolved
projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid.component.ts
Outdated
Show resolved
Hide resolved
projects/igniteui-angular/src/lib/time-picker/time-picker.component.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Konstantin Dinev <kdinev@mail.bw.edu>
damyanpetev
changed the title
Update deprecated comments & contributing guide, fix invalid tag
docs(*): update deprecated comments, contributing guide; fix tags
Apr 5, 2024
kdinev
approved these changes
Apr 5, 2024
kdinev
approved these changes
Apr 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: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: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:
editorconfig.editorconfig
EditorConfig for the.editorconfig
file support (already present in the repo)dbaeumer.vscode-eslint
ESLint integrationangular.ng-template
Angular Language Servicestreetsidesoftware.code-spell-checker
Code Spell Checker for those pesky typosLet me know if more should be added to the list. Also considering a section in the guidelines somewhere
Additional information (check all that apply):
Checklist:
feature/README.MD
updates for the feature docsREADME.MD
CHANGELOG.MD
updates for newly added functionalityng update
migrations for the breaking changes (migrations guidelines)