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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document history API #48

Open
mnquintana opened this issue Oct 15, 2015 · 1 comment
Open

Document history API #48

mnquintana opened this issue Oct 15, 2015 · 1 comment

Comments

@mnquintana
Copy link

Some currently undocumented methods of the history API (like getFragment) are very useful for users of this package - any change you'd consider documenting them publicly? 馃槃

@wraithgar
Copy link
Contributor

Yes! Absolutely. Documentation is extremely helpful and important. The general rule of thumb in the past has been that if it's documented, it should have test coverage. A quick scan of the existing tests seems to indicate that this is already the case with getFragment.

If this is something you're considering, please know that documentation updates are very easy to get merged in. They only require one person on the team to see it, like it, and merge it in.

If you don't want to do this, no problem. We will leave this issue here and try to get some momentum on it. Thanks for this suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants