search

tealdeer-rs / tealdeer

A very fast implementation of tldr in Rust.
https://tealdeer-rs.github.io/tealdeer/
Apache License 2.0
4.17k stars 123 forks source link

Move shell completion scripts to their own directory #259

Closed SimplyDanny closed 2 years ago

SimplyDanny commented 2 years ago

The names of the scripts are unchanged. We could rename them to the scheme used by clap-generate to be prepared. 😉 What do you think?

Is there something else to update? Scripts? Documentation?

niklasmohrin commented 2 years ago

There is a mention of the bash and fish completion files in Cargo.toml, I am not sure why though :thinking: @dbrgn ?

Other than that, I can't find any other places

There should definitely be a mention in CHANGELOG.md, but this will be added whenever we release the next time. I am not sure if we need to explicitly notify package maintainers about the change, if we mention it in the changelog - but that is a task for us, not you :)

dbrgn commented 2 years ago

Could you also update the upload-completions job in .github/workflows/release.yml?

There is a mention of the bash and fish completion files in Cargo.toml, I am not sure why though 🤔 @dbrgn ?

Hm, I think those could/should be removed as well.

SimplyDanny commented 2 years ago

Could you also update the upload-completions job in .github/workflows/release.yml?

Done.

Hm, I think those could/should be removed as well.

Done.

The names of the scripts are unchanged. We could rename them to the scheme used by clap-generate to be prepared. 😉 What do you think?

I guess you missed this question. Shall we keep the names for now or use the ones produced by clap-generate already?

niklasmohrin commented 2 years ago

In my opinion we should stick to the current names, even if we had clap-generate. The names are better suited for use in this repo and you have to copy them anyways, so renaming doesnt add any complexity then either