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

Improve online documentation #139

Open
jstac opened this issue Apr 17, 2015 · 1 comment
Open

Improve online documentation #139

jstac opened this issue Apr 17, 2015 · 1 comment

Comments

@jstac
Copy link
Contributor

jstac commented Apr 17, 2015

The documentation would be better if functions and classes all had at least one example and possibly more. E.g., see the examples here:

http://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.expon.html

There is a section devoted to examples. In the NumPy / SciPy docs, I find this section is often more useful than any other kind of documentation. I propose we push towards improving our documentation in this way.

@oyamad
Copy link
Member

oyamad commented Aug 6, 2015

It would be helpful if we have a style guide for the Examples section (just for a reference point).

We have a 2x2 table of choices regarding the following:

  • whether include the import statement;
  • if random, whether specify random_state.

Example:

With import

>>> import quantecon as qe
>>> qe.random.sample_without_replacement(5, 3)
array([2, 3, 4])

Without import

With random_state

>>> qe.random.sample_without_replacement(5, 3, random_state=1234)
array([0, 2, 1])

Without random_state

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

No branches or pull requests

3 participants