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

Criterium 0.5.x #45

Open
wants to merge 90 commits into
base: develop
Choose a base branch
from
Open

Criterium 0.5.x #45

wants to merge 90 commits into from

Conversation

hugoduncan
Copy link
Owner

@hugoduncan hugoduncan commented Jul 29, 2019

Next version 0.5.x of criterium. This is a major rewrite.

@hugoduncan hugoduncan force-pushed the factor-out-toolkit branch from 3e50d9c to 41b3bbd Compare July 29, 2019 12:30
@hugoduncan hugoduncan changed the title Factor out toolkit Criterium 0.5.x Nov 19, 2021
@hugoduncan hugoduncan force-pushed the factor-out-toolkit branch 3 times, most recently from b3d4362 to 51a57e1 Compare December 22, 2021 23:07
@hugoduncan hugoduncan force-pushed the factor-out-toolkit branch 5 times, most recently from 5a7d061 to 7ad96d0 Compare January 2, 2022 03:03
- Enhance namespace documentation with purpose and features
- Add parameter and return value documentation
- Include practical usage examples for public functions
- Create new criterium.bench.impl namespace for implementation details
- Move last-bench* volatile to implementation namespace
Make the portal and pprint viewers work with out explicit requires of
the viewers.

- add portal example to bench doc string
- Enhanced namespace docstring with clear explanation of Measured concept
- Added detailed documentation for invoke function return values
- Improved args function documentation
- Added performance and memory guarantees to documentation
- Document why the argument is not a primitive
- Add comprehensive docstrings for public functions
- Include parameter descriptions and defaults
- Add working code examples
- Document return values and requirements
- Maintain consistent documentation structure
- Add comprehensive namespace and function documentation
- Improve function naming for clarity
- Add input validation for benchmark specification
- Improve error handling with ex-info
- Make composition pattern more explicit
- Add usage examples in docstrings
- Add docstrings for functions
- Include parameter descriptions and defaults
- Add code examples
- Document return values and requirements
- Maintain consistent documentation structure
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.

1 participant