Skip to content

Document when a new function / class / method / attribute was introduced for the 0.18 release #5505

@ogrisel

Description

@ogrisel

Sphinx makes it possible to declare when a new feature was added using thie versionadded directive:

http://sphinx-doc.org/markup/para.html#directive-versionadded

We should review all the classes / functions / methods / attributes introduced in 0.17 (see the changelog) and add a ..versionadded:: 0.17 declaration in the docstring for those elements.

It's also a good opportunity to add the missing links to the github PR numbers (or issue number if no PR) when those features where added to the matching entry of doc/whats_new.rst.

A similar issue is used to track the work related to the 0.17 release: #5504.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationEasyWell-defined and straightforward way to resolve

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions