https://pantsbuild.org/ logo
#development
Title
# development
p

proud-dentist-22844

03/10/2023, 9:33 PM
I'm exploring
help
in 2.16.0a0 - excellent! A few points - if they're unknown, I can file issues.
./pants help backends
and
./pants help-advanced backends
show the same content (both include preview/experimental backends).
./pants help backends
shows that
pants.backend.build_files.fix.deprecations
and
pants.backend.build_files.fmt.black
are NOT enabled by default, but I thought they were -- at least
update-build-files
runs black on all the BUILD files without that being enabled... is the depredations fixer actually disabled by default? How do we add documentation to
./pants help backends
? Some of them have a description and others don't - is that exposing a module-level docstring in the module that has
register.py
? @curved-television-6568
./pants help
does not show
./pants help symbols
, but the help works marvelously. It also does not say that we can use
help <symbol>
.
h

happy-kitchen-89482

03/10/2023, 9:45 PM
I'm wondering if
help-advanced
still makes sense, or is just confusing?
apropos of nothing, but since you mentioned it it reminded me of that
p

proud-dentist-22844

03/10/2023, 9:47 PM
They seem to be pretty much the same thing. Though, I can imagine moving api-types and rules under advanced as most users won't care about that. Minimizing the number of "what's that?" a user has to go through to answer their question is a good thing.
I think in
./pants help
there should be only one entry for
./pants help-advanced
that users can use to see all of the other
help-advanced
options. (maybe)
h

happy-kitchen-89482

03/10/2023, 9:51 PM
The idea was that
help
would be for options you might want to specify as a CLI flag, and
help-advanced
would be for all the other options (ones you'd specify via config)
But I'm not sure we think about that any more when we set
advanced=True
on an option
plus as you say there is a lot of help now that is not about options
c

curved-television-6568

03/10/2023, 10:59 PM
./pants help backends
and
./pants help-advanced backends
show the same content (both include preview/experimental backends).
whops. idea was to only show experimental with the help-advanced option (unless it was enabled).
./pants help backends
shows that
pants.backend.build_files.fix.deprecations
and
pants.backend.build_files.fmt.black
are NOT enabled by default, but I thought they were -- at least
update-build-files
runs black on all the BUILD files without that being enabled... is the depredations fixer actually disabled by default?
iirc the enabled by default list is hard coded, so may have gotten that wrong.
How do we add documentation to
./pants help backends
? Some of them have a description and others don’t - is that exposing a module-level docstring in the module that has
register.py
?
yes, module level docstgring from register.py for the corresponding backend
please file away 😉
p

proud-dentist-22844

03/10/2023, 11:01 PM
Yeah.
update-build-files
list is hard-coded. Apparently, you can ALSO have
pants.backend.build_files.fix.deprecations
run when running the
fix
goal. In any case, that output is a bit confusing.
c

curved-television-6568

03/10/2023, 11:02 PM
@curved-television-6568
./pants help
does not show
./pants help symbols
, but the help works marvelously. It also does not say that we can use
help <symbol>
.
❤️ oversights 😉
2 Views