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

Rewrite documents with yard #1635

Merged
merged 5 commits into from
Dec 4, 2021
Merged

Rewrite documents with yard #1635

merged 5 commits into from
Dec 4, 2021

Commits on Dec 3, 2021

  1. Install yard

    @st0012
    st0012 committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    3255920 View commit details
    Browse the repository at this point in the history

  2. Adopt yard format for documenting top-level APIs

    @st0012
    st0012 committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    73a0e51 View commit details
    Browse the repository at this point in the history

  3. 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)
```
    @st0012
    st0012 committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    508e816 View commit details
    Browse the repository at this point in the history

  4. Mark private components

    @st0012
    st0012 committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    d830721 View commit details
    Browse the repository at this point in the history

  5. Document configuration options with yard

    @st0012
    st0012 committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    e828bfd View commit details
    Browse the repository at this point in the history