Skip to content

Docs: readers on the PyPI release see behaviour from unreleased versions #330

Description

@allen0099

Problem

The GitHub/Read the Docs pages follow master, so they describe unreleased behaviour, for example "Before 0.3.9 only MemoryBackend had aclose()". Someone who installs the current PyPI release and reads the latest docs calls methods their version does not have, and nothing on the page tells them which version it describes.

Proposal

Pick one:

  • publish versioned docs (a stable build from the latest tag next to latest), or
  • mark unreleased features in the docs ("New in 0.3.9, unreleased") and show the documented version on every page.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions