Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix help text for stevedore_namespace BUILD file symbol. #20984

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Conversation

kaos
Copy link
Member

@kaos kaos commented May 31, 2024

Closes #20977

❯ pants --backend-packages=pants.backend.experimental.python.framework.stevedore stevedore_namespace --help
`stevedore_namespace` BUILD file symbol
---------------------------------------

Tag a namespace in entry_points as a stevedore namespace.

This is required for the entry_point to be visible to dep inference
based on the `stevedore_namespaces` field.

For example:
    python_distribution(
        ...
        entry_points={{
            stevedore_namespace("a.b.c"): {{
                "plugin_name": "some.entry:point",
            }},
        }},
    )

Closes #20977

```
❯ pants --backend-packages=pants.backend.experimental.python.framework.stevedore stevedore_namespace --help
`stevedore_namespace` BUILD file symbol
---------------------------------------

Tag a namespace in entry_points as a stevedore namespace.

This is required for the entry_point to be visible to dep inference
based on the `stevedore_namespaces` field.

For example:
    python_distribution(
        ...
        entry_points={{
            stevedore_namespace("a.b.c"): {{
                "plugin_name": "some.entry:point",
            }},
        }},
    )
```
@kaos kaos added category:documentation release-notes:not-required PR doesn't require mention in release notes labels May 31, 2024
@kaos
Copy link
Member Author

kaos commented May 31, 2024

TIL: f-strings don't work as __doc__ strings. (I may have known this in the past, but re-discovered it today..)

Copy link
Contributor

@huonw huonw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oooh, subtle. Good catch.

Copy link
Contributor

@huonw huonw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one!

@huonw huonw merged commit b0f4ce0 into main Jun 4, 2024
25 checks passed
@huonw huonw deleted the kaos/20977 branch June 4, 2024 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:documentation release-notes:not-required PR doesn't require mention in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

stevedore_namespace documentation shows str's doc string
2 participants