Skip to content

DOC: remove usage of code-block directive in docstrings + fix some warnings #5903

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

Merged

Conversation

jorisvandenbossche
Copy link
Member

Some docs things:

  • remove remaining use of code-block, closes Go through package docstrings and markup code snippets as such #3430 (@y-p, I think that were the last ones, so now it can be really closed)
  • fix some headers to avoid useless warnings during doc build (if the line under the header is not as long as the header itself, sphinx complains about it although it renders fine)

@ghost
Copy link

ghost commented Jan 11, 2014

"markup code snippets as such" somehow became "remove usage of code-block in docstrings"
somewhere along the way, but as long as it's consistent across the package it's fine by me.

merge away.

@jorisvandenbossche
Copy link
Member Author

@y-p yeah .. it's indeed maybe not exactly the same as the issue (but it is also more difficult to search the code snippets that are not highlighted as code), but I don't mean remove code blocks, but the literal use of code-block and replace with eg :: as the code-block is redundant.

jorisvandenbossche added a commit that referenced this pull request Jan 12, 2014
DOC: remove usage of code-block directive in docstrings + fix some warnings
@jorisvandenbossche jorisvandenbossche merged commit dd89ce4 into pandas-dev:master Jan 12, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Go through package docstrings and markup code snippets as such
1 participant