<#20977 `stevedore_namespace` documentation shows ...
# github-notifications
c
#20977 `stevedore_namespace` documentation shows `str`'s doc string Issue created by huonw Describe the bug The
stevedore_namespace
BUILD file symbol has a doc-string, but it isn't shown in
pants help-all
. It instead shows what looks like the doc string for
str
. pants/src/python/pants/backend/python/framework/stevedore/target_types.py Lines 13 to 30 in </pantsbuild/pants/commit/ec86d19cd954cd49a9562880a7c0dbc45632778c|ec86d19> To reproduce, enable the stevedore backend and look at
help
or `help-all`:
Copy code
PANTS_VERSION=2.22.0.dev3 pants --backend-packages=pants.backend.experimental.python.framework.stevedore help stevedore_namespace
Copy code
`stevedore_namespace` BUILD file symbol
---------------------------------------

str(object='') -> str
str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or
errors is specified, then the object must expose a data buffer
that will be decoded using the given encoding and error handler.
Otherwise, returns the result of object.__str__() (if defined)
or repr(object).
encoding defaults to sys.getdefaultencoding().
errors defaults to 'strict'.
Copy code
PANTS_VERSION=2.22.0.dev3 pants --backend-packages=pants.backend.experimental.python.framework.stevedore help-all | \
  jq .name_to_build_file_info.stevedore_namespace
Copy code
{
  "documentation": "str(object='') -> str\nstr(bytes_or_buffer[, encoding[, errors]]) -> str\n\nCreate a new string object from the given object. If encoding or\nerrors is specified, then the object must expose a data buffer\nthat will be decoded using the given encoding and error handler.\nOtherwise, returns the result of object.__str__() (if defined)\nor repr(object).\nencoding defaults to sys.getdefaultencoding().\nerrors defaults to 'strict'.",
  "is_target": false,
  "name": "stevedore_namespace",
  "signature": null
}
Pants version Seems to be visible in 2.16 through to the currently latest. OS both Additional info • Will appear in online docs too after pantsbuild/pantsbuild.org#216 • Relevant issues: • #18117#14832 pantsbuild/pants