Skip to content

WIP Update documentating guide #9804

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

Closed
wants to merge 1 commit into from
Closed

Conversation

dstansby
Copy link
Member

Needs a bit more work, but the aim is to fix #9786 eventually and generally clean the writing documentation guide. Comments very welcome and encouraged!


.. rubric:: Footnotes

.. [#]

.. rubric:: Footnotes

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been fairly ruthless deleting stuff here, as how to do all this properly is documented in the numpydoc guide (which I will add a link to in this document at some point)

@anntzer
Copy link
Contributor

anntzer commented Nov 16, 2017

I would really appreciate if #9311 could go in first...

I had closed it because I was hoping for #9513 to be merged first and resolve the conflicts in #9311 after that, but I can resolve the conflicts in the other direction to if that's needed :/.

@jklymak
Copy link
Member

jklymak commented Nov 16, 2017

Ah, @anntzer thats what you were talking about the other day. I looked at your open issues and didn't see what you meant! I'll try and review and merge #9311 after the tests build (if someone doesn't beat me to it).

@anntzer
Copy link
Contributor

anntzer commented Nov 16, 2017

I was planning to reopen it after #9513 goes it, but whatever.

@dstansby
Copy link
Member Author

Woops, sorry, I forgot about those. Let me close this for now and I'll have a look at your PRs.

@dstansby dstansby closed this Nov 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistent Documentation Guide for Docstrings
3 participants