ENH: Add the polynomial module to the documentation. #91
Conversation
|
The Routines section in the refguide is organized by topic, so I propose you merge the polynomial and poly1d sections under the "Polynomials" topic. This would then be section 3.15 for example, with the polynomial module 3.15.1 and poly1d 3.15.2. Also, I think it would be good to add a few lines of explanation that poly1d is kept for backwards compatibility, but new code should use the polynomial module. Backporting for 1.6.1 should be no problem. |
|
OK, I've done that, it required another index for polynomials. However, I haven't pushed it to my repository yet because I trying to figure out why there are 4333 warnings when building the docs and missing links in the result. And that with a clean checkout of maintenance/1.6.x for reference. Is there a known problem with sphinx 1.0.7? |
|
That's a few more than there should be. Yes, Sphinx 1.0.7 has a problem, something related to class templates. Use 1.0.4. I seem to remember about 800 warnings, that's a good number. Don't ask me why:) |
|
Sphinx 1.0.4 is incompatible with recent docutils and the development version errors out early. So be it, 4333 warnings it is ;) |
1. Note that the polynomial package is preferred over poly1d. 2. Remove deprecation of mapparms in __init__.py as it interferes with the documention of the method of the same name. This is probably safe as it is unlikely to be used yet. 3. Make some improvements to the documentation in polytemplate.
|
Looks good. Committed to master, will backport to 1.6.x before release. |
feat: Add vrshl_s8
This patch provides basic documentation of the polynomial module. There are fixes and a lot of details that can be added later, but I wanted to keep it minimally intrusive so it could be backported to the upcoming 1.6.1 release.