Skip to content

Notes comparing NotImplementedError and NotImplemented have inconsistent linking #129015

@nexushoratio

Description

@nexushoratio

Documentation

The link to the OtherItem is in different locations in the otherwise similar notes. One with the See OtherItem, the other in the sentence calling out they are different. They should probably be consistent.

I personally think they should be like in constants, with the See OtherItem sentence.

constants.html reads:

Note: NotImplementedError and NotImplemented are not interchangeable, even though they have similar names and purposes. See NotImplementedError for details on when to use it.

exceptions.html reads:

Note: NotImplementedError and NotImplemented are not interchangeable, even though they have similar names and purposes. See NotImplemented for details on when to use it.

``NotImplementedError`` and :data:`!NotImplemented` are not interchangeable,
even though they have similar names and purposes.
See :exc:`NotImplementedError` for details on when to use it.

``NotImplementedError`` and :data:`NotImplemented` are not interchangeable,
even though they have similar names and purposes. See
:data:`!NotImplemented` for details on when to use it.

I don't know RST. Is it simply moving the ! in exceptions from line 340 to line 338?

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions