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

API of latest release (v3.1.0) doesn't match tutorial / README #31

Closed
chohner opened this issue May 13, 2020 · 4 comments
Closed

API of latest release (v3.1.0) doesn't match tutorial / README #31

chohner opened this issue May 13, 2020 · 4 comments
Assignees
@martinus
Labels
documentation Improvements or additions to documentation
Milestone
4.0.0

Comments

@chohner
Copy link

chohner commented May 13, 2020

The latest v3.1.0 release does not match any of the examples since changing Config to Bench. This is quite a big (currently) undocumented API break and potentially warrants a new release?
@chohner chohner changed the title Release doesn't match tutorial / README Latest release API doesn't match tutorial / README May 13, 2020
@chohner chohner changed the title Latest release API doesn't match tutorial / README API of latest release (v3.1.0) doesn't match tutorial / README May 13, 2020
@andersfylling
Copy link

I'm struggling with this too.

@martinus martinus self-assigned this May 30, 2020
@martinus
Copy link
Owner

Unfortunately the documentation is out of date. The coming release 4.0 is quite a big refactoring which has changed a lot of the API, and I'll have to update most of the documentation for that.

@martinus martinus added the documentation Improvements or additions to documentation label May 30, 2020
@martinus martinus added this to the 4.0.0 milestone May 30, 2020
@martinus
Copy link
Owner

martinus commented Jun 8, 2020 •
edited
Loading

You can find the most recent nanobench documentation here: https://nanobench.ankerl.com/

  • Describe & update templating
  • source comments: Result
  • source comments: doNotOptimizeAway
  • source comments: BigO
  • source comments: templates namespace

For 4.1.0:

  • document Internals (how autoscaling works, PerformanceCounters tuning)
  • benchmark & speed up compilation

@martinus
Copy link
Owner

Huge update to the documentation, I consider this finished for 4.0.0.

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

@martinus martinus

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
4.0.0
Development

No branches or pull requests
3 participants
@martinus @andersfylling @chohner