docs(docs-infra): improve the content of attribute directives #44628
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
atscott
requested changes
Jan 5, 2022
| @@ -11,7 +11,9 @@ export class HighlightDirective { | |||
| @Input() defaultColor = ''; | |||
| // #enddocregion defaultColor | |||
|
|
|||
| // #docregion highlightColor | |||
There was a problem hiding this comment.
I don't think the intent of this tutorial was to introduce aliases. Can we instead change the code and content to consistently use appHighlight?
There was a problem hiding this comment.
It's a good idea to consistently use appHighlight. And I have changed the PR.
Improve docs "Understanding Angular-Directives-Attribute Directives" In `highlight.directive.1.ts`, add the `private` keyword for `el` property to make it correct and consistent with subsequent examples. For section "Setting the value with user input", add a step to tell the reader change the method `onMouseEnter`, thus more readable. For section "Binding to a second property", delete the aliase for the `Input` property, and changes the name back to `appHighlight` in the code to make it consistent with the whole tutorial.
atscott
added
aio: preview
comp: docs
target: patch
|
You can preview 89eb30a at https://pr44628-89eb30a.ngbuilds.io/. |
atscott
approved these changes
Jan 6, 2022
|
This PR was merged into the repository by commit 7f51f1d. |
atscott
pushed a commit
that referenced
this pull request
Jan 6, 2022
Improve docs "Understanding Angular-Directives-Attribute Directives" In `highlight.directive.1.ts`, add the `private` keyword for `el` property to make it correct and consistent with subsequent examples. For section "Setting the value with user input", add a step to tell the reader change the method `onMouseEnter`, thus more readable. For section "Binding to a second property", delete the aliase for the `Input` property, and changes the name back to `appHighlight` in the code to make it consistent with the whole tutorial. PR Close #44628
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Improve docs "Understanding Angular-Directives-Attribute Directives"
In
highlight.directive.1.ts, add theprivatekeyword forelpropertyto make it correct and consistent with subsequent examples.
For section "Setting the value with user input", add a step to tell the
reader change the method
onMouseEnter, thus more readable.For section "Binding to a secon property", add a step to tell the reader
should add an alias because the docs doesn't mention it at all, thus
more readable.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
https://angular.io/guide/attribute-directives
Issue Number: N/A
What is the new behavior?
In
highlight.directive.1.ts, add theprivatekeyword forelproperty to make it correct and consistent with subsequent examples.After:
For section "Setting the value with user input", add a step to tell the reader change the method
onMouseEnter, thus more readable.After:
For section "Binding to a second property", add a step to tell the reader should add an alias because the docs doesn't mention it at all, thus more readable
After
Does this PR introduce a breaking change?
Other information