Components: Remove example code from JSDoc

Created on 1 Nov 2019  路  8Comments  路  Source: angular/components

Documentation Feedback

API docs with usage example code don't get formatted. We should avoid putting code snippets in these API docs.

Our Overview (sourced from .md file) and Examples is where example code should live.

Affected documentation page:

P4 docs good first issue help wanted

All 8 comments

Hey @Splaktar, I would like to contribute to this issue. I went through the contribution guidelines, spinned up a local dev environment, but I do not know how to proceed further as I am unable to locate the docs template in the dev environment for it. Since this is my first time contributing to any project, I feel stupid asking such a seemingly stupid question, but I would really like to contribute to this one.

I have added a PR for this issue: #17622. I updated the comments in the documentation for APIs as I could not spin up a local env for the docs.

Sorry for the delay in responding. The docs can be run locally via a separate repo: https://github.com/angular/material.angular.io. Unfortunately, it's currently a tough process to test unmerged changes in the Components repo in the Docs repo.

But now that your changes are merged, you should be able to load up that repo, update the docs-content, and then verify that it looks good.

Thanks @Splaktar . I tried starting the dev environment for material.angular.io and followed the dev setup steps. But I get an error:
ERROR in Cannot resolve type entity i1.CdkPopoverEditExamplesModule to symbol. Is there something that I am missing?

@ssupdoc that's due to some refactoring that we did recently in the components repo. I just merged in PR https://github.com/angular/material.angular.io/pull/673 to resolve this.

@Splaktar That's cool. I pulled in the latest and the API documentation looks good now. Thanks for helping me out 馃憤

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._

Was this page helpful?
0 / 5 - 0 ratings

Related issues

michaelb-01 picture michaelb-01  路  3Comments

savaryt picture savaryt  路  3Comments

RoxKilly picture RoxKilly  路  3Comments

dzrust picture dzrust  路  3Comments

constantinlucian picture constantinlucian  路  3Comments