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

Add option to explain the astronomy terms #228

Open
Deuchnord opened this issue Dec 11, 2021 · 6 comments
Open

Add option to explain the astronomy terms #228

Deuchnord opened this issue Dec 11, 2021 · 6 comments
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@Deuchnord
Copy link
Member

Deuchnord commented Dec 11, 2021

Is your feature request related to a problem? Please describe.
It is currently quite difficult to get the meaning of all the information given by the command, especially the astronomy terms.
There is currently a man page dedicated to this, but you have to know it exists, which is not obvious.

Describe the solution you'd like

  • Delete the current kosmorro.7 manpage
  • Add an --explain option that will allow Kosmorro to explain the terms shown by the current command. For instance, if the return of the command tells about a conjunction, explain what is a conjunction.
  • Add support for a KOSMORRO_EXPLAIN environment variable to activate this behavior permanently.
  • Proposal by @Damgermys: add a second --definitions that would list all the words like the manpage currently does. In this case, the program does not make any calculation.

Additional context
The new information should be added at least to the Plain Text output. It could be nice to get it to the PDF output too, though.

@Deuchnord Deuchnord added enhancement New feature or request good first issue Good for newcomers labels Dec 11, 2021
@Deuchnord Deuchnord added this to the v1.0 milestone Dec 11, 2021
@ghost
Copy link

ghost commented Dec 15, 2021

Hi guys, can I help with this issue?

@Deuchnord
Copy link
Member Author

Yes, you can, @romco1410, feel free to create a PR :)

@Deuchnord Deuchnord assigned ghost Dec 15, 2021
@ghost
Copy link

ghost commented Dec 16, 2021

Thanks @Deuchnord, It will be fixed in 2 weeks, then ill write some tests for this also.

@ghost
Copy link

ghost commented Jan 4, 2022

Hi @Deuchnord i have done work on this issue and before PR a want to test the written code, but none of recommendation from contributing.md works. Can you give me some hint?

@Deuchnord
Copy link
Member Author

Don't worry about the tests, I'm doing a full rewrite in #209, so the Bash script will not be used anymore ;)

@ghost
Copy link

ghost commented Jan 4, 2022

Ok theres a list of work what I did on this issue:

  1. I have made new file terms.py containing terms from kosmorro.7 manpage in python dictionary, so they can be easily processed.
  2. I have deleted kosmorro.7 manpage.
  3. --explain option was added to list terms as you described, it supports KOSMORRO_EXPLAIN env variable as well.
  4. --definitions option lists all terms same formated as manpage without any calculations.

Should I make PR to master or feature branch ?

@ghost ghost mentioned this issue Jan 4, 2022
1 task
@Deuchnord Deuchnord linked a pull request Mar 11, 2022 that will close this issue
1 task
@Deuchnord Deuchnord modified the milestones: v1.0, v1.1 Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant