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

docgen: generate namespace for symbols #14332

Closed
oandregal opened this issue Mar 8, 2019 · 2 comments
Closed

docgen: generate namespace for symbols #14332

oandregal opened this issue Mar 8, 2019 · 2 comments
Labels
[Package] Docgen /packages/docgen

Comments

@oandregal
Copy link
Member

Explore the use of @namespace/@memberof to document where the symbols are to find. For example: the symbols within the rich-text package are to find in wp.richText package. How do we document that?

Potential approach: we could have a --namespace=wp.richText option for docgen that will add the necessary boilerplate (@memberof to symbols, global @namespace, etc.) to the intermediate representation without developers needing to write it one by one. Formatters then will take that input and could prepend the symbols with wp.richText, or group them by namespace when we are ready to present this info in developer.wordpress.org, etc.

Ref:

@paaljoachim
Copy link
Contributor

Close?

@oandregal
Copy link
Member Author

It's still relevant but if nobody has worked on it for so long we can assume it can go to the backburner. We can always re-open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Docgen /packages/docgen
Projects
None yet
Development

No branches or pull requests

2 participants