Enhance documentation & enforce 100% coverage #743
+50
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #707.
Several improvements focused on documentation:
docs:coverage
extracts the documented percentage from yard stats and fails the build if it is below the specified level (currently set to 100%).lib/mocha.rb
andlib/mocha/integration.rb
) are part of the generated documentation.lib/mocha.rb
provides an overview of the API, the mocking methods, and integration hooks.Integration
module and theAdapter
s under it include module-level comments to clarify their purpose.