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.

Sign up for GitHub

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

Jump to bottom

docs-infra: render `@see` tags on class members #28069

Closed

petebacondarwin wants to merge 2 commits into angular:master from petebacondarwin:aio-see-also-on-members

Member

petebacondarwin commented Jan 11, 2019

Related to #26812 (comment)

petebacondarwin added 2 commits

January 11, 2019 11:16


          build(docs-infra): render @see information in members

f32f857

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.


          docs(forms): fix up @see tags for AbstractContol

9b30d4d

petebacondarwin added feature action: review effort1: hours freq1: low comp: docs-infra target: patch risk: low labels

petebacondarwin added this to the docs-infra-tooling milestone

petebacondarwin requested review from a team as code owners

January 11, 2019 11:20

googlebot added the cla: yes label

petebacondarwin mentioned this pull request

feat(forms): add markAllAsTouched() to AbstractControl #26812

Closed

14 tasks

petebacondarwin commented

View reviewed changes

packages/forms/src/model.ts

    
            @@ -198,7 +198,7 @@ export abstract class AbstractControl {
          
                /**

                 * A control is `valid` when its `status` is `VALID`.

                 *

                 * @see `status`

                 * @see {@link AbstractControl.status}

Member Author

petebacondarwin Jan 11, 2019

The status code block can be resolved ambiguously to multiple docs so we have to make it more explicit. We could have just put

@see `AbstractControl.status`

But this would result in having the full Abstract.status text in the link. Doing it this way, we only get the name of the member in the link text.

mary-poppins commented Jan 11, 2019

You can preview 9b30d4d at https://pr28069-9b30d4d.ngbuilds.io/.

gkalpak approved these changes

View reviewed changes

kara approved these changes

View reviewed changes

Contributor

kara left a comment

LGTM

kara added action: merge and removed action: review labels

Contributor

AndrewKushnir commented Jan 11, 2019

AndrewKushnir closed this in

cd51775

AndrewKushnir pushed a commit that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (#28069)

9a128a8

PR Close #28069

AndrewKushnir pushed a commit that referenced this pull request


          build(docs-infra): render @see information in members (#28069)

b102835

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close #28069

AndrewKushnir pushed a commit that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (#28069)

3c08b86

PR Close #28069

kyliau pushed a commit to kyliau/angular that referenced this pull request


          build(docs-infra): render @see information in members (angular#28069)

4cff872

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close angular#28069

kyliau pushed a commit to kyliau/angular that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (angular#28069)

74ebd9e

PR Close angular#28069

gkalpak added this to REVIEW in docs-infra

petebacondarwin added a commit to petebacondarwin/angular that referenced this pull request


          build(docs-infra): render @see information in members (angular#28069)

7b76664

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close angular#28069

petebacondarwin added a commit to petebacondarwin/angular that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (angular#28069)

a401278

PR Close angular#28069

AndrewKushnir pushed a commit that referenced this pull request


          build(docs-infra): render @see information in members (#28069)

305331f

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close #28069

AndrewKushnir pushed a commit that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (#28069)

47840be

PR Close #28069

wKoza pushed a commit to wKoza/angular that referenced this pull request


          build(docs-infra): render @see information in members (angular#28069)

d28e202

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close angular#28069

wKoza pushed a commit to wKoza/angular that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (angular#28069)

3c5429e

PR Close angular#28069

wKoza pushed a commit to wKoza/angular that referenced this pull request


          build(docs-infra): render @see information in members (angular#28069)

0afceeb

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close angular#28069

wKoza pushed a commit to wKoza/angular that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (angular#28069)

579b631

PR Close angular#28069

ngfelixl pushed a commit to ngfelixl/angular that referenced this pull request


          build(docs-infra): render @see information in members (angular#28069)

152fc93

Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close angular#28069

ngfelixl pushed a commit to ngfelixl/angular that referenced this pull request


          docs(forms): fix up @see tags for AbstractContol (angular#28069)

29d829a

PR Close angular#28069

angular-automatic-lock-bot bot commented Sep 14, 2019

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

angular-automatic-lock-bot bot locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.