Skip to content

fix(yard): resolve yard doc warnings #1764

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

vburzynski
Copy link
Contributor

Fixes warnings generated when generating the yard documentation:

❯ be yard doc
/Users/valerie/.asdf/installs/ruby/3.4.2/lib/ruby/gems/3.4.0/gems/yard-0.9.37/lib/yard/templates/helpers/markup_helper.rb:105: warning: rdoc was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.5.0.
You can add rdoc to your Gemfile or gemspec to silence this warning.
[warn]: @param tag has unknown parameter name: name 
    in file `lib/factory_bot/syntax/methods.rb' near line 86
[warn]: @param tag has unknown parameter name: traits_and_overrides 
    in file `lib/factory_bot/syntax/methods.rb' near line 86
[warn]: @param tag has unknown parameter name: block 
    in file `lib/factory_bot/syntax/methods.rb' near line 86
[warn]: @param tag has unknown parameter name: name 
    in file `lib/factory_bot/syntax/methods.rb' near line 92
[warn]: @param tag has unknown parameter name: amount 
    in file `lib/factory_bot/syntax/methods.rb' near line 92
[warn]: @param tag has unknown parameter name: traits_and_overrides 
    in file `lib/factory_bot/syntax/methods.rb' near line 92
[warn]: @param tag has unknown parameter name: block 
    in file `lib/factory_bot/syntax/methods.rb' near line 92
[warn]: @param tag has unknown parameter name: name 
    in file `lib/factory_bot/syntax/methods.rb' near line 99
[warn]: @param tag has unknown parameter name: traits_and_overrides 
    in file `lib/factory_bot/syntax/methods.rb' near line 99
[warn]: @param tag has unknown parameter name: block 
    in file `lib/factory_bot/syntax/methods.rb' near line 99
[warn]: In file `README.md':8: Cannot resolve link to Interested from text:
        ...{Interested in the history of the project name?}...
[warn]: In file `README.md':36: Cannot resolve link to <code>.github/workflows/build.yml</code><a from text:
        ...{<code>.github/workflows/build.yml</code><a href="https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml">}...
[warn]: In file `README.md':8: Cannot resolve link to Interested from text:
        ...{Interested in the history of the project name?}...
[warn]: In file `README.md':36: Cannot resolve link to <code>.github/workflows/build.yml</code><a from text:
        ...{<code>.github/workflows/build.yml</code><a href="https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml">}...
[warn]: In file `GETTING_STARTED.md':55: Cannot resolve link to <code>build_stubbed</code> from text:
        ...{<code>build_stubbed</code> and <code>Marshal.dump</code><a href="#build_stubbed-and-marshaldump">}...
[warn]: In file `GETTING_STARTED.md':65: Cannot resolve link to With from text:
        ...{With <code>attributes_for</code><a href="#with-attributes_for">}...
[warn]: In file `GETTING_STARTED.md':97: Cannot resolve link to <code>has_many</code> from text:
        ...{<code>has_many</code> associations}...
[warn]: In file `GETTING_STARTED.md':99: Cannot resolve link to <code>has_and_belongs_to_many</code> from text:
        ...{<code>has_and_belongs_to_many</code> associations}...
Files:          53
Modules:         6 (    5 undocumented)
Classes:        56 (   47 undocumented)
Constants:       4 (    4 undocumented)
Attributes:     23 (   20 undocumented)
Methods:       222 (  143 undocumented)
 29.58% documented

@vburzynski vburzynski force-pushed the vb-fix-yard-warnings branch from fe688bb to cb4f60a Compare August 15, 2025 22:50
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