(docs) Add namespace to all public methods #552

merged 1 commit into from Nov 15, 2015


None yet

2 participants


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

@keithamus keithamus merged commit 34a2f17 into chaijs:master Nov 15, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
@keithamus keithamus deleted the keithamus:add-namespace-to-docs branch Nov 15, 2015

@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?


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.

@astorije astorije referenced this pull request in astorije/chai-immutable Apr 10, 2016

Fix #39: Add namespaces to all assertions #49

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