Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document valid encoding values #410

Open
elshize opened this issue Jun 8, 2020 · 0 comments
Open

Document valid encoding values #410

elshize opened this issue Jun 8, 2020 · 0 comments
Labels
documentation help wanted Extra attention is needed

Comments

@elshize
Copy link
Member

elshize commented Jun 8, 2020

All available encoding values should be documented. There is somewhat incomplete documentation here: https://pisa.readthedocs.io/en/latest/compress_index.html (only mentions actual values of the parameter for some compression techniques).

I think we should do the following:

  • complete the documentation by adding missing values,
  • make them stand out more by maybe documenting them right below each header,
  • linking that documentation page in the CLI description of --encoding

Ideally, we could print all available values in the --help but some refactoring of how we define them in the code might be in order first. (like getting rid of the macro, try using templates instead) so I suggest the above at the moment.

@elshize elshize added documentation help wanted Extra attention is needed labels Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant