Rewrite documents with yard #1635
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
```
[warn]: Load Order / Name Resolution Problem on Rake::Application:
-
Something is trying to call mixins on object Rake::Application before it has been recognized.
This error usually means that you need to modify the order in which you parse files
so that Rake::Application is parsed before methods or other objects attempt to access it.
-
YARD will recover from this error and continue to parse but you *may* have problems
with your generated documentation. You should probably fix this.
-
[error]: Unhandled exception in YARD::Handlers::Ruby::MixinHandler:
in `lib/sentry/rake.rb`:31:
31: Rake::Application.prepend(Sentry::Rake::Application)
```
Codecov Report
@@ Coverage Diff @@
## master #1635 +/- ##
=======================================
Coverage 98.51% 98.51%
=======================================
Files 133 133
Lines 7412 7415 +3
=======================================
+ Hits 7302 7305 +3
Misses 110 110
Continue to review full report at Codecov.
|
sl0thentr0py
approved these changes
Dec 3, 2021
st0012
added a commit
that referenced
this pull request
Jan 4, 2022
* Install yard
* Adopt yard format for documenting top-level APIs
* Fix YARD::Handlers::Ruby::MixinHandler in rake extension
```
[warn]: Load Order / Name Resolution Problem on Rake::Application:
-
Something is trying to call mixins on object Rake::Application before it has been recognized.
This error usually means that you need to modify the order in which you parse files
so that Rake::Application is parsed before methods or other objects attempt to access it.
-
YARD will recover from this error and continue to parse but you *may* have problems
with your generated documentation. You should probably fix this.
-
[error]: Unhandled exception in YARD::Handlers::Ruby::MixinHandler:
in `lib/sentry/rake.rb`:31:
31: Rake::Application.prepend(Sentry::Rake::Application)
```
* Mark private components
* Document configuration options with yard
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Given that
yardis still the major format for Ruby documentation, using it to document SDK will make it more accessible for our users. More importantly, it provides a format for type information, which will be essential when we later add documentation forSentry::Eventand different event interfaces.