Massive doc-style work, focused upon axes.py. #765
Conversation
Also added entry in index.html for 'subplots'.
|
I can't say that I looked at every change in great detail, but these all look like good and reasonable improvements. Thanks for going some not-so-fun grunt work ;) |
| Turn *y* autoscaling on (*True*), off (*False*; default), | ||
| or leave unchanged (*None*) | ||
|
|
||
| Note, the *bottom* (formerly *ymin*) value may be greater than |
There was a problem hiding this comment.
Would the ``.. note::` directive render things nicer here, or is that too loud?
There was a problem hiding this comment.
I thought about that, but I think it would be too "loud" because of the code examples that would have to go inside the note box as well.
|
I have gone through this pull and it looks good to me. |
I should add that I have only reviewed the changes made, not identified changes not made. So there may well still be examples of code blocks not being lead with a |
|
Given I know the sphinx "basic" theme has a stickysidebar option (http://sphinx.pocoo.org/theming.html), but unfortunately it doesn't exist on the sphinxdoc theme. |
|
A stickysidebar idea is actually not a bad one. I have been so focused on the content of the documentation that I have not really looked into what else is possible with sphinx. I will take a gander. |
|
Probably the other more important change that is needed is a overhaul of the documentation guide page. This is in major need of rework to not only provide important style guides to developers, but also possibly a cheat-sheet to contributors to make documenting easier by knowing exactly what is expected where. |
| @@ -83,7 +81,7 @@ | |||
| for 'dots' or 'inches', resizing does not change the arrows. | |||
|
|
|||
|
|
|||
| *angles*: ['uv' | 'xy' | array] | |||
| *angles*: [ 'uv' | 'xy' | array] | |||
There was a problem hiding this comment.
Remove leading space on this line.
There was a problem hiding this comment.
Leading space? You mean the space I added there to match with just about all the other docstrings? Note that I just noticed that I also should add a space after "array" on that line as well.
There was a problem hiding this comment.
ah, nevermind, I see what you mean.
|
@WeatherGod, it would be good to get this committed ASAP, so with or without the two indentation fixes I noted above, I suggest you go ahead and merge this. |
Weather god docfixes 1.1.1
|
Ok, this is a huge step forward. I am gonna go ahead and get this merged in. |
Massive doc-style work, focused upon axes.py.
Also added entry in index.html for 'subplots'.
The style changes are not exhaustive, but I tried to find the most visible ones. Also fixed a lot of common :class: references (Colormap is in colors.py, not cm.py!). Should eventually convert a lot of the argument descriptions into ReST tables.