Skip to content

Discuss adding :meta private: to the doc string #1502

Open
Open
Discuss adding :meta private: to the doc string#1502
Labels
issue-status: wait-for-implementationmaintainers agree on the bug / feature

Description

@bearomorphism
bearomorphism
opened on Jun 4, 2025

We probably can try something like adding :meta private: to the doc string instead. Even though it's a sphinx thing, I think this should be sufficient

Originally posted by @Lee-W in #1466 (comment)

Activity

  1. github-actions
    added
    issue-status: needs-triage
    on Jun 4, 2025
  2. Lee-W
    added
    issue-status: wait-for-implementationmaintainers agree on the bug / feature
    and removed
    issue-status: needs-triage
    on Jun 5, 2025

  3. Lee-W commented on Jun 5, 2025

    @Lee-W
    Lee-W
    on Jun 5, 2025
    Member

    it's more like choose between _func_name and :meta private:. We use both in Airflow. But Airflow uses Sphinx. can discuss a bit on what we want

  4. Lee-W commented on Jun 5, 2025

    @Lee-W
    Lee-W
    on Jun 5, 2025
    Member

    relates to #1446

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

    issue-status: wait-for-implementationmaintainers agree on the bug / feature

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions