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

entry.fileComment is documented wrong #47

Closed
thejoshwolfe opened this issue Oct 25, 2016 · 0 comments
Closed

entry.fileComment is documented wrong #47

thejoshwolfe opened this issue Oct 25, 2016 · 0 comments
Labels

Comments

@thejoshwolfe
Copy link
Owner

thejoshwolfe commented Oct 25, 2016

In the README, the field is called entry.comment. In the code, it's called entry.fileComment. It's possible that users have written code that relies on either on of these, so we should make them both exist as aliases of one another.

The README will now document that entry.fileComment is the recommended way, and entry.comment is deprecated.

We should also add a test for file comments. If it's in the README, it needs first-class support, and that means tests.

@thejoshwolfe thejoshwolfe changed the title entry.comment is documented wrong entry.fileComment is documented wrong Oct 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant