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

Remove CLI options clutter #181

Open
kontur opened this issue Sep 6, 2024 · 1 comment
Open

Remove CLI options clutter #181

kontur opened this issue Sep 6, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested
Milestone

Comments

@kontur
Copy link
Contributor

kontur commented Sep 6, 2024

Over the course of development we've added a bunch of CLI options that need reviewing:

  1. autonyms: To output the CLI result with language names as autonyms
  2. speakers: To output the language speaker count in the CLI result
  • We don't have autonyms for all; this is broken now and outputs empty strings for those languages
  • Both are too granular.

I think we should drop and add a line to the end of the output:

You can find more information about a language by typing hyperglot-data Languagename

We could include the number of overall covered speakers at the end of each CLI output, sort of like the hyperglot webapp does it at the bottom of the left-hand column.

  1. output: Needs fixing so the python Orthography object is output as dict into the yaml
  2. comparison: This outputs a kind of diff between multiple fonts, which on top can be union'ed or intersect'ed — imo this is beyond the CLI. Users wanting to compare multiple fonts in a analytical way should use the library -> remove option and provide sample code how to do this
  3. languages: Pre hyperglot-data option to output a specific language's data at the end of the CLI output. This just needs to be removed, the hyperglot-data Languagename instruction should be added instead.
  4. strict_iso: "Flag to display names and macrolanguage data strictly abiding to ISO data. Without it apply some gentle transforms to show preferred languages names and macrolanguage structure that deviates from ISO data." — I think this adds noise/complexity to the CLI that regular users will never care about. The strict option can still be used when invoking the library, so I think for users that might do more analytical comparisons they are likely to use the library, not the CLI. I'd move to the remove.
@kontur kontur self-assigned this Sep 6, 2024
@kontur kontur added documentation Improvements or additions to documentation question Further information is requested labels Sep 6, 2024
@kontur
Copy link
Contributor Author

kontur commented Sep 6, 2024

@MrBrezina thoughts?

@kontur kontur added this to the 0.7.0 milestone Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant