iterative / shtab

↔️ Automagic shell tab completion for Python CLI applications
https://docs.iterative.ai/shtab
Other
363 stars 35 forks source link

[doc] Enable wiki #119

Closed Freed-Wu closed 1 year ago

Freed-Wu commented 1 year ago
Freed-Wu commented 1 year ago

@casperdcl

Freed-Wu commented 1 year ago

How about enabling a wiki for this project https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis and https://docs.github.com/en/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis and let all people edit it to add new project which use shtab?

Freed-Wu commented 1 year ago

@omesser

casperdcl commented 1 year ago

unless there's some reason a wiki is better, I'd prefer you open a PR on the docs instead.

omesser commented 1 year ago

unless there's some reason a wiki is better, I'd prefer you open a PR on the docs instead.

not splitting up the content will help keep maintainence overhead lower for us and help focus poeple in one place. Sounds ok @Freed-Wu?

Freed-Wu commented 1 year ago

Oh, I think every package developers who use this project can add their package names to wiki and wiki can be edit directly without creating a PR, which should be easier than opening a PR so it can encourage them to add their package names.

casperdcl commented 1 year ago

Perhaps; though I'm sceptical about quality & usefulness.

FYI things like https://github.com/inducer/pudb/blob/1dea19a3a14ba2398e5b7909eb86cad0c0152b3d/pudb/run.py and https://github.com/iterative/dvc/blob/2ef2caafd3f7c540caed4cb60fe3d9ff0255caf9/dvc/cli/completion.py are worth mentioning - and such a list would rarely need updating. By comparison, I'm not sure that just linking to setup.py files is useful (https://github.com/iterative/shtab/network/dependents is much more up-to-date and impressive).

Freed-Wu commented 1 year ago

https://github.com/iterative/shtab/network/dependents?dependent_type=REPOSITORY is only for repository, https://github.com/iterative/shtab/network/dependents?dependent_type=PACKAGE is the list including all packages depending on shtab and looks good. Can we mention https://github.com/iterative/shtab/network/dependents?dependent_type=PACKAGE as a list of example projects which use shtab?