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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for parsing style and options #41

Merged
merged 1 commit into from
Jul 31, 2020
Merged

Improve documentation for parsing style and options #41

merged 1 commit into from
Jul 31, 2020

Conversation

murarth
Copy link
Owner

@murarth murarth commented Jul 30, 2020

Fixes #39
Fixes #40

@murarth
Copy link
Owner Author

murarth commented Jul 30, 2020

@Timmmm: I've added a link to ParsingStyle in every place "default parsing style" is mentioned and added some examples there to clarify the difference in these behaviors.

I've also added a link to the crate-level docs from the Options derive macro.

I hope this makes usage clearer. If not, please let me know how things can be further improved.

@Timmmm
Copy link

Timmmm commented Jul 31, 2020

Nice one, thanks!

@murarth murarth merged commit 1502c3b into master Jul 31, 2020
@murarth murarth deleted the improve-docs branch July 31, 2020 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Not obvious how to have required arguments Not clear what "default parsing style" is
2 participants
@murarth @Timmmm