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

update benchmark documentation to match code #444

Open
goatshriek opened this issue Sep 26, 2024 · 0 comments
Open

update benchmark documentation to match code #444

goatshriek opened this issue Sep 26, 2024 · 0 comments
Labels
documentation documentation updates good first issue something that would be simple for a newcomer to stumpless to work on help wanted external contributations encouraged low code work that requires little to no coding proficiency

Comments

@goatshriek
Copy link
Owner

The documentation for benchmarking includes a walkthrough of running performance tests on a piece of code, refactoring it, and testing for improvement.

While the content of the walkthrough is still relevant, the code snippet included for the performance test itself has not been updated to match the current performance test template, which is simpler to read and understand.

This is a simple change: update the benchmarking documentation code snippet for the CopyElement test to match the implementation in test/performance/element.cpp.

If you are up for it, refactor the test to make it even simpler by using the fixture function create_entry to construct an entry with elements, rather than doing this manually. This is optional though, and if you would rather focus on the mechanics of making changes to files and issuing a pull request, you are free to leave this change out.

@goatshriek goatshriek added help wanted external contributations encouraged good first issue something that would be simple for a newcomer to stumpless to work on documentation documentation updates low code work that requires little to no coding proficiency hacktoberfest labels Sep 26, 2024
@goatshriek goatshriek changed the title update benchmark documentation update benchmark documentation to match code Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation updates good first issue something that would be simple for a newcomer to stumpless to work on help wanted external contributations encouraged low code work that requires little to no coding proficiency
Projects
None yet
Development

No branches or pull requests

1 participant