8000 DOC: Explain how our shared_docs system works · Issue #16446 · pandas-dev/pandas · GitHub
[go: up one dir, main page]

Skip to content
DOC: Explain how our shared_docs system works #16446
@TomAugspurger

Description

@TomAugspurger

Enhance https://github.com/pandas-dev/pandas/blob/master/doc/source/contributing.rst with a discussion of how our _shared_docs system works.

  • Why we do it (reduce duplicate docstrings, while still having some class-specific stuff)
  • How it's done (Appender, _shared_docs dict, _shared_doc_kwargs)
  • How to substitute values

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0