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

Addon-docs: Angular ArgTypes for pipes, injectables, classes #11016

Merged
merged 2 commits into from
Jun 3, 2020

Conversation

matheo
Copy link
Member

@matheo matheo commented Jun 2, 2020

Issue:

We document some Pipes, Services and Classes of the system,
but they were not extracted from the Compodoc documentation.

What I did

I included them in the typing and ArgTypes extraction.
The ArgsTable seems to need some tweaks to display the private stuff,
but it's still useful as it is right now.

@matheo
Copy link
Member Author

matheo commented Jun 3, 2020

@shilman any opinion about this?

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

@matheo Looks great!! 😍 Can you add examples to examples/angular-cli so I can see it working in the monorepo?

@matheo matheo requested review from alterx and igor-dv as code owners June 3, 2020 08:09
@matheo
Copy link
Member Author

matheo commented Jun 3, 2020

@shilman done!
we could add another option to controls to disable the warnings for some stories, like

{ controls: { showWarning: false } }

what do you think? I could have a simple PR to extend that if you agree.
PS/ and if you have a better name for that flag just share it ;)

@shilman
Copy link
Member

shilman commented Jun 3, 2020

What would showWarning: false do?

@matheo
Copy link
Member Author

matheo commented Jun 3, 2020

just hides the NoControlsWarning (inside ControlsPanel) in case we just don't want to have controls, nor have a warning in the panel :)
maybe there's a better name for this flag

@shilman
Copy link
Member

shilman commented Jun 3, 2020

Aha makes sense. hideNoControlsWarning: true ?

@shilman shilman changed the title Docs: extract ArgTypes for Angular pipes, injectables and classes Addon-docs: Angular ArgTypes for pipes, injectables, classes Jun 3, 2020
@shilman shilman merged commit 6efa4cc into storybookjs:next Jun 3, 2020
@matheo matheo deleted the feat/compodoc-classes branch June 3, 2020 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants