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

Find ways to better help users #55

Merged
merged 3 commits into from
Oct 10, 2018
Merged

Find ways to better help users #55

merged 3 commits into from
Oct 10, 2018

Conversation

epage
Copy link
Contributor

@epage epage commented Oct 10, 2018

This is a part of #37

epage added 3 commits October 9, 2018 18:15
@epage
docs: Better highlight API
3a33a7b 
This is done in two main ways
- More examples
- More intermediate variables in examples to better highlight how the
  API works.
@epage
docs: Provide a custom TOC
d65c591
@epage
docs: Add a more thorough example
547503c
@epage epage merged commit 680cabb into assert-rs:master Oct 10, 2018
@epage epage deleted the docs branch October 10, 2018 02:25
killercup
killercup reviewed Oct 10, 2018
View reviewed changes
Copy link
Contributor

@killercup killercup left a comment

Choose a reason for hiding this comment

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

Maybe it'd make sense to tell people how to use tests that return Results and use that in doc comments?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@killercup killercup killercup left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@epage @killercup