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 Document to Store Simple Tax Records #764

Merged
merged 7 commits into from
Aug 4, 2016

Conversation

GoFroggyRun
Copy link
Contributor

This PR adds a new document for Tax-Calculator that stores some interesting (counter-intuitive) phenomenon we have encountered so far: odd (high) marginal tax rate, #555, and optimization puzzle, #752, for the moment. Contents included in the document are:

  1. Introduction of this document
  2. Different situations where each section contains:
    • Overview of the situation
    • Brief explanation of the reason
    • Simple tax record that would yield the situation
    • Guide on how to use Tax-Calculator to reproduce the situation

This document helps users and developers to have a good grasp of the reasons behind those "weird" phenomenons. This document will continue to be updated once interesting units/situations have been found.

Any comments, concerns or remarks on the name of this document, content of the document or format of the document would be mostly welcomed.

@martinholmer @MattHJensen @Amy-Xu @feenberg

@codecov-io
Copy link

codecov-io commented Jun 1, 2016

Current coverage is 98.12% (diff: 100%)

Merging #764 into master will not change coverage

@@             master       #764   diff @@
==========================================
  Files            13         13          
  Lines          1809       1809          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1775       1775          
  Misses           34         34          
  Partials          0          0          

Powered by Codecov. Last update fc80557...ad4b10d

@martinholmer
Copy link
Collaborator

@GoFroggyRun, I would suggest a different name for the new markdown file in pull request #764.

Instead of RECORD.md (which makes it sound as if you are going to discuss just one record), why not call the new file: ODD_RECORDS.md. This name indicates that more than one record is going to be discussed and that the records being discussed are "special" or "unusual" or "odd" in some way.

@MattHJensen @feenberg @Amy-Xu @zrisher

@GoFroggyRun
Copy link
Contributor Author

@martinholmer, thanks for your comment regarding the name for the markdown.
ODD_RECORDS.md seems much more appropriate to me as well.

Please let me know if you have any other suggestions or comments.

@MattHJensen
Copy link
Contributor

Merging. Thanks a lot @GoFroggyRun. Very much looking forward to more contributions on this documentation from you and others in the future. @GoFroggyRun, I think this resolves #753 -- if you agree, could you close the issue?

@MattHJensen MattHJensen merged commit c34ce25 into PSLmodels:master Aug 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants