Docs erroneously say that odict.add() only has two mandatory parameters

[alexwlchan]

Quoting from the Extension API docs (emphasis mine):

The add() method accepts three arguments:

• key: A string. The key is used for later reference to the item.
• value: The object instance stored in this item.
• location: Optional. The items location in relation to other items.

But the source code for the method shows that all three arguments are required:

def add(self, key, value, location):
    """ Insert by key location. """

Either the "Optional" should be removed from the docs, or the parameter should be made optional.

I’d mildly prefer the latter, as I have some cases where the location really doesn’t matter, but it’s not a strong preference.

[waylan]

Not sure why the docs say "optional". It never has been and doesn't make sense to be. I'll update the docs. Thanks for the report.

[john-kurkowski]

Thanks! Can you publish the doc update? http://pythonhosted.org/Markdown/extensions/api.html#ordereddict still says "Optional."

[waylan]

The docs are updated on each release.

[waylan]

Hmm, looks like we didn't update the docs when we released 2.6.9. Opps.

[facelessuser]

Docs don't auto-deploy on release? I figured they did, but I never really checked.

[waylan]

No, I never got that automated. The releases are so few and far between and it was never a problem to run make docs and then use the "edit" page on PyPI to upload the zip file. That is, until now. See #601 for the current state and my proposal to address it.

[facelessuser]

Have you settled on a theme? If you have (and when I have some time), I can probably set it up.

[facelessuser]

That is of course if you are ready to jump to Mkdocs.

[waylan]

The switch to MkDocs exists in the md3 branch at 6f87b32. That commit should "cherry-pick" and merge relatively easily. And I just finished and released the MkDocs-Nature theme to use with it (the md3 branch is currently using readthedocs). Whoever gets to it first...