Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

DOC: Ensure guides are linked from relevant API docs #62357

@afeld

Description

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

Pages under https://pandas.pydata.org/docs/reference/index.html

Documentation problem

I've come across pages in the API reference that have a corresponding Getting Started / User Guide, but don't link to them. (Failing to find an example at the moment.) This is a shame, because the guides are generally more beginner-friendly.

Suggested fix for documentation

I suggest doing a content audit:

  1. Go through each guide.
  2. Click the links to the API docs.
  3. For the API docs that don't link back to the guide, submit a pull request to add them.

If you wanna get fancy, you could write code to do that 😉 No idea how hard that would be with Sphinx.

Metadata

Metadata

Type

Projects

No projects

Milestone

No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      AltStyle によって変換されたページ (->オリジナル) /