From: Eric F. <ef...@ha...> - 2011-05-20 23:58:31
|
On 05/20/2011 11:48 AM, Benjamin Root wrote: > > > I have made a few more small changes, and I have an additional change > that I have not committed yet. The table of contents for the examples > page has every single example titled as something like "animation > example code:". This is repeatitive and distracting. In the same > spirit of removing "matplotlib" from the titles of the api subsections, > I wanted to do the same here. I figured out how to do that without > changing the actual titles of the subsections. > > So, my question is, do we want that? If so, I can push up the change to Yes! > my pull request. I still have to do some merge work apparently, but > otherwise, I think I am done with the major changes to the v1.0.x docs. > Is there anything else we want to fix before I merge this pull request? Sounds to me like this is a good time to merge it. > > Some other ideas I have had is to include a link to the glossary page in > the page header next to "docs", and maybe the FAQ, as well? I also want Glossary? I didn't even know there was one, so putting in a prominent link to it sounds like a good idea. I think that putting a FAQ link up front is also a good idea; maybe it will help remind us to keep expanding the FAQ when we keep seeing the same question on the mailing list. > to expand the glossary page, and comb through the docstrings to > incorporate more ":term:" usage. However, I probably want to hold off > on those ideas for the master branch. > > Let me know what you all think of the docs! I have not yet tried to build from your branch, but based on descriptions and discussions, it should be a substantial improvement. Go ahead and push when you feel ready. Thank you for all the work. Eric > Ben Root > |