feat: add init and benchmarks commands to docs#276
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
docs/source/cli-init.md
Outdated
|
|
||
| ## Notes | ||
|
|
||
| - The `<repo>` part is normalized to lowercase, and `-` is replaced with `_`. For example, `my-user/My-Kernel` becomes a directory named `my_kernel` and a repo id `my-user/my_kernel`. |
There was a problem hiding this comment.
I think I missed this when reviewing init, - should only be converted to lowercase in the Python package name (build/<variant>/my_kernel), not in the repo name, the kernel directory name, or the kernel name in build.toml. We prefer regular dashes there and maybe we should even do the opposite, let kernel init change my-user/my_kernel to myuser/my-kernel.
There was a problem hiding this comment.
ah yea great point, just pushed changes to prefer dashes in the dir the kernel name and underscores/lowercase in the python naming
19ef9ce to
783dc33
Compare
|
merging as this adds many missing commands to the docs. we can rollback if needed otherwise we can follow up with improvements in the near future |
This PR simply adds new docs for the
initandbenchmarksubcommands