Comments (7)
yes, there are only two columns at the moment.
from comonicon.jl.
Sorry what I meant is the vertical spacing – seems to have a lot of space between each argument (especially at the top):
Compared to a regular man page:
and, e.g., julia itself:
from comonicon.jl.
you mean no space between commands? Or there is double space before Usage?
from comonicon.jl.
Right now it gets printed like this:
benchpkg
Usage
benchpkg <args> [options] [flags]
Args
[package_name] Name of the package. If not given, will be inferred.
Options
-r, --rev <arg> Revisions to test (delimit by comma). Use dirty to
benchmark the current state of the package at path
(and not a git commit). If not given, will be inferred based
on context.
-o, --output-dir <arg> Where to save the JSON results.
-s, --script <arg> The benchmark script. Default:
benchmark/benchmarks.jl downloaded from
stable.
-e, --exeflags <arg> CLI flags for Julia (default: none).
-a, --add <arg> Extra packages needed (delimit by comma).
--url <arg> URL of the package.
--path <arg> Path of the package.
--bench-on <arg> If the script is not set, this specifies the revision at
which to download benchmark/benchmarks.jl from the
package.
-f, --filter <arg> Filter the benchmarks to run (delimit by comma).
--nsamples-load-time <arg> Number of samples to take when measuring load time of the
package (default: 5). (This means starting a Julia process
for each sample.)
Flags
--tune Whether to run benchmarks with tuning (default: false).
-h, --help Print this help message.
--version Print version.
I would like it to get printed as this:
benchpkg
Usage
benchpkg <args> [options] [flags]
Args
[package_name] Name of the package. If not given, will be inferred.
Options
-r, --rev <arg> Revisions to test (delimit by comma). Use dirty to
benchmark the current state of the package at path
(and not a git commit). If not given, will be inferred based
on context.
-o, --output-dir <arg> Where to save the JSON results.
-s, --script <arg> The benchmark script. Default:
benchmark/benchmarks.jl downloaded from
stable.
-e, --exeflags <arg> CLI flags for Julia (default: none).
-a, --add <arg> Extra packages needed (delimit by comma).
--url <arg> URL of the package.
--path <arg> Path of the package.
--bench-on <arg> If the script is not set, this specifies the revision at
which to download benchmark/benchmarks.jl from the
package.
-f, --filter <arg> Filter the benchmarks to run (delimit by comma).
--nsamples-load-time <arg> Number of samples to take when measuring load time of the
package (default: 5). (This means starting a Julia process
for each sample.)
Flags
--tune Whether to run benchmarks with tuning (default: false).
-h, --help Print this help message.
--version Print version.
To save on vertical space.
from comonicon.jl.
The proposed format here looks too dense to me when the description is long, it's hard to tell which text belong to which option, which was why I put space in between, so it's not a bug it's a feature... I'm OK with having an option to turn this on/off. But I currently don't have the capacity to work on it. I'm preparing my defense. It shouldn't be too hard to add it here: https://github.com/comonicon/Comonicon.jl/blob/main/src/ast/printing.jl#L51
from comonicon.jl.
it's hard to tell which text belong to which option
I agree with that – I think it would also be nice to reduce the margin in the middle. See the Julia help menu:
It's nice because (a) it fits in my terminal window, and (b) you can still associate text and options.
from comonicon.jl.
yeah, it's prob because the two columns are too far. I agree with that.
from comonicon.jl.
Related Issues (20)
- julia args HOT 1
- [Request] Allow short option to not be first letter of long HOT 5
- [BUG] sysimage_build_args isn' t configurable
- [BUG] Infinite build time on Julia 1.10 HOT 13
- [BUG] test failing for hint
- Control the empty lines in the usage doc HOT 2
- Base now exports `@main` HOT 3
- Provide overloads of `tryparse` for common stdlib types
- [BUG] Command description not printin in help
- [feature request] Run `command_main()` only when running script frome the command line HOT 2
- [BUG] `Vararg` does not work on recent Julia versions
- [BUG] Help text wraps; terminal width not detected correctly HOT 2
- [BUG] ERROR: System image file failed consistency check: maybe opened the wrong version?
- Sysimage precompilation error on Github CI / Docker image
- Clarify README about what this package does HOT 2
- PackageCompiler fails to build standalone app because it attempts to bundle mingw-w64 [BUG]
- [BUG] documentation not upto date with `ion`
- [BUG] @cast does not work on Julia 1.11 HOT 7
- Latency increase from 1.10 to 1.11 HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from comonicon.jl.