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

updated readme #154

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

noman404
Copy link
Collaborator

@noman404 noman404 commented Dec 16, 2024

updated readme added inputs and outputs

Fixes #152
Fixes #141

Copy link
Contributor

@MaxGhenis MaxGhenis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please fix the spacing in the table as well (chatgpt can)

also note i edited the original comment to use the fixes keyword for both issues. this ensures clarity so we don't have to check the development sidebar

README.md Outdated
| depx | Number of dependents | |
| age1 | First dependent's age | |
| age2 | Second dependent's age | |
| ageN | Nth dependent's age | Taxsim only allow upto 8 children dependent |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Child dependents or total dependents?

Suggested change
| ageN | Nth dependent's age | Taxsim only allow upto 8 children dependent |
| ageN | Nth dependent's age | Taxsim only allows up to 8 child dependents |

Copy link
Contributor

@MaxGhenis MaxGhenis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more from pr-improver.streamlit.app

Based on the provided diff and guidelines, here are 5 specific suggestions to improve the PR:

  1. File: README.md, Line 59
    Change: "Incase of" to "In case of"
    Explanation: This corrects a spelling error, improving readability for all users, especially non-native English speakers.

  2. File: README.md, Line 59-60
    Change: "Incase of any unexpected system error happens, you can uninstall the package and reinstall it again"
    to "If you encounter any unexpected system errors, you can uninstall the package and reinstall it:"
    Explanation: This rephrases the sentence to be more clear and concise, improving readability.

  3. File: README.md, Line 79
    Change: Add a note about the output file format
    Add: "Note: The output is in a tab-separated text format, not CSV."
    Explanation: This clarifies the output format for users, preventing confusion about the file type.

  4. File: README.md, Line 86
    Change: Add a brief explanation of the state code
    Add: "state | State code (FIPS) | Two-digit code, e.g., 06 for California"
    Explanation: This provides more context for the state code, helping users understand what value to input.

  5. File: README.md, Line 117-119
    Change: Add brief descriptions for the output types
    Update to:

    | idtl | Description                                        |
    |------|----------------------------------------------------|
    | 0    | Standard output (basic tax calculation results)    |
    | 2    | Full output (detailed breakdown of calculations)   |
    | 5    | Full text output (human-readable explanations)     |
    

    Explanation: This provides more context for each output type, helping users choose the appropriate option for their needs.

These suggestions focus on improving clarity and providing more context for users, especially those who might not be familiar with the US tax system or TAXSIM conventions. They address spelling and grammar issues while also adding helpful explanations to make the documentation more user-friendly.

README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants