Skip to content

feat(docs): show additional type aliases in docs. #11901

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

Merged

Conversation

devversion
Copy link
Member

  • Shows type aliases that belong to specific components in the documentation (e.g. MatSnackBarHorizontalPosition)

Closes #10468

@devversion devversion added the docs This issue is related to documentation label Jun 23, 2018
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jun 23, 2018
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you share a screenshot of what it would look like in the docs?

@devversion
Copy link
Member Author

devversion commented Jun 27, 2018

It looks like that:

image

That's just the generated HTML inserted into the docs.

Additional styling (like making the type bold) can be still made afterwards in the docs. For now it was just important to output the type definitions for some components.

Let me know if you have any ideas on how to improve it -- I considered splitting the types and showing them as an <li>, but that involves too much work to re-parse the AST.

@devversion devversion force-pushed the feat/docs-show-type-aliases branch from 3b13cbd to f0b6111 Compare June 27, 2018 17:04
* Shows type aliases that belong to specific components in the documentation (e.g. `MatSnackBarHorizontalPosition`)

Closes angular#10468
@devversion devversion force-pushed the feat/docs-show-type-aliases branch from f0b6111 to 1a516ef Compare June 27, 2018 17:08
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, that works for me

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release and removed target: master only labels Jun 27, 2018
@josephperrott josephperrott merged commit 637ef83 into angular:master Jun 28, 2018
@angular-automatic-lock-bot
Copy link

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 angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(snackbar): Add description for MatSnackBarHorizontalPosition and MatSnackBarVerticalPosition
4 participants