You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Explore the use of
@namespace
/@memberof
to document where the symbols are to find. For example: the symbols within therich-text
package are to find inwp.richText
package. How do we document that?Potential approach: we could have a
--namespace=wp.richText
option fordocgen
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 withwp.richText
, or group them by namespace when we are ready to present this info in developer.wordpress.org, etc.Ref:
The text was updated successfully, but these errors were encountered: