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

(docs) Add namespace to all public methods #552

Merged
merged 1 commit into from Nov 15, 2015

Conversation

Projects
None yet
2 participants
@keithamus
Member

keithamus commented Nov 15, 2015

This will make generating the new sites' docs much easier.

@astorije

This comment has been minimized.

Show comment
Hide comment
@astorije

astorije Feb 29, 2016

Member

@keithamus, I am planning to add this as well in astorije/chai-immutable#39, at least for consistency with Chai, as I try to match the docstrings of my plugin as closely as possible to Chai's docstrings.
Just wondering, does this and the other docstring data have any impact on the new site docs for plugins in general?

Member

astorije commented Feb 29, 2016

@keithamus, I am planning to add this as well in astorije/chai-immutable#39, at least for consistency with Chai, as I try to match the docstrings of my plugin as closely as possible to Chai's docstrings.
Just wondering, does this and the other docstring data have any impact on the new site docs for plugins in general?

@keithamus

This comment has been minimized.

Show comment
Hide comment
@keithamus

keithamus Feb 29, 2016

Member

It won't for plugins - this was just for core to generate docs. Feel free to add docstrings to help you maintain your own docs though.

Also, you should take a look at #585, which will hopefully lead to having an easy way to generate docs, among other good things.

Member

keithamus commented Feb 29, 2016

It won't for plugins - this was just for core to generate docs. Feel free to add docstrings to help you maintain your own docs though.

Also, you should take a look at #585, which will hopefully lead to having an easy way to generate docs, among other good things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment