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

Document examples #351

Merged
merged 5 commits into from
Mar 31, 2017
Merged

Document examples #351

merged 5 commits into from
Mar 31, 2017

Conversation

devreal
Copy link
Member

@devreal devreal commented Mar 30, 2017

This PR adds the \example tag to most of the examples, as requested in #106.

Additionally, it fixes the return values in dash::any_of and dash::all_of (bool instead of iterator) and fixes some glitches in the documentation across the project.

Please check the documentation (as I haven't written the code it might be incorrect/incomplete) and feel free to extend it.

@fuchsto Should the benchmarks be marked as \example as well? I have a patch for that but have not committed it yet.

@devreal devreal added this to the dash-0.3.0 milestone Mar 30, 2017
@devreal devreal self-assigned this Mar 30, 2017
@devreal devreal requested a review from fuchsto March 30, 2017 08:26
@fuchsto
Copy link
Member

fuchsto commented Mar 31, 2017

@devreal Thank you for taking care of this rather boring task! Benchmarks will move to dash-project/dash-bench so no need to document them as examples for now.

@fuchsto fuchsto merged commit 1978c10 into development Mar 31, 2017
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.

2 participants