fix(yard): fix remaining yard doc warnings

Author: vburzynski

.gitignore

@@ -1,14 +1,22 @@
+.bundle
+.rubocop-https*
+.yardoc
+.zed
 *.swp
+bin
+coverage
 test.db
-factory_girl-*.gem
+tmp
+
+# yard
+doc
+
+# gem builds
 factory_bot-*.gem
+factory_girl-*.gem
+
+# mdBook generated output
 docs/book
-.yardoc
-coverage
-.bundle
-tmp
-bin
-.rubocop-https*
-.zed
 
+# lock files generated by appraisal
 gemfiles/*.lock

GETTING_STARTED.md

@@ -17,86 +17,87 @@ at any time.
 Getting Started
 ===============
 
-* [Setup](#setup)
-  + [Update Your Gemfile](#update-your-gemfile)
-  + [Configure your test suite](#configure-your-test-suite)
+- [Setup](#setup)
+  - [Update Your Gemfile](#update-your-gemfile)
+  - [Configure your test suite](#configure-your-test-suite)
     - [RSpec](#rspec)
     - [Test::Unit](#testunit)
     - [Cucumber](#cucumber)
     - [Spinach](#spinach)
     - [Minitest](#minitest)
     - [Minitest::Spec](#minitestspec)
     - [minitest-rails](#minitest-rails)
-* [Defining factories](#defining-factories)
-  + [Factory name and attributes](#factory-name-and-attributes)
-  + [Specifying the class explicitly](#specifying-the-class-explicitly)
-  + [Hash attributes](#hash-attributes)
-  + [Best practices](#best-practices)
-  + [Definition file paths](#definition-file-paths)
-  + [Static Attributes](#static-attributes)
-* [Using factories](#using-factories)
-  + [Build strategies](#build-strategies)
-  + [Attribute overrides](#attribute-overrides)
-  + [`build_stubbed` and `Marshal.dump`](#build_stubbed-and-marshaldump)
-* [Aliases](#aliases)
-* [Dependent Attributes](#dependent-attributes)
-* [Transient Attributes](#transient-attributes)
-  + [With other attributes](#with-other-attributes)
-  + [With `attributes_for`](#with-attributes_for)
-  + [With callbacks](#with-callbacks)
-  + [With associations](#with-associations)
-* [Method Name / Reserved Word Attributes](#method-name--reserved-word-attributes)
-* [Inheritance](#inheritance)
-  + [Nested factories](#nested-factories)
-  + [Assigning parent explicitly](#assigning-parent-explicitly)
-  + [Best practices](#best-practices-1)
-* [Associations](#associations)
-  + [Implicit definition](#implicit-definition)
-  + [Explicit definition](#explicit-definition)
-  + [Inline definition](#inline-definition)
-  + [Specifying the factory](#specifying-the-factory)
-  + [Overriding attributes](#overriding-attributes)
-  + [Association overrides](#association-overrides)
-  + [Build strategies](#build-strategies-1)
-  + [`has_many` associations](#has_many-associations)
-  + [`has_and_belongs_to_many` associations](#has_and_belongs_to_many-associations)
-  + [Polymorphic associations](#polymorphic-associations)
-  + [Interconnected associations](#interconnected-associations)
-* [Sequences](#sequences)
-  + [Global sequences](#global-sequences)
-  + [With dynamic attributes](#with-dynamic-attributes)
-  + [As implicit attributes](#as-implicit-attributes)
-  + [Inline sequences](#inline-sequences)
-  + [Initial value](#initial-value)
-  + [Without a block](#without-a-block)
-  + [Aliases](#aliases-1)
-  + [Rewinding](#rewinding)
-  + [Uniqueness](#uniqueness)
-* [Traits](#traits)
-  + [Defining traits](#defining-traits)
-  + [As implicit attributes](#as-implicit-attributes-1)
-  + [Attribute precedence](#attribute-precedence)
-  + [In child factories](#in-child-factories)
-  + [Using traits](#using-traits)
-  + [With associations](#with-associations-1)
-  + [Traits within traits](#traits-within-traits)
-  + [With transient attributes](#with-transient-attributes)
-  + [Enum traits](#enum-traits)
-* [Callbacks](#callbacks)
-  + [Default callbacks](#default-callbacks)
-  + [Multiple callbacks](#multiple-callbacks)
-  + [Global callbacks](#global-callbacks)
-  + [Symbol#to_proc](#symbolto_proc)
-* [Modifying factories](#modifying-factories)
-* [Building or Creating Multiple Records](#building-or-creating-multiple-records)
-* [Linting Factories](#linting-factories)
-* [Custom Construction](#custom-construction)
-* [Custom Strategies](#custom-strategies)
-* [Custom Callbacks](#custom-callbacks)
-* [Custom Methods to Persist Objects](#custom-methods-to-persist-objects)
-* [ActiveSupport Instrumentation](#activesupport-instrumentation)
-* [Rails Preloaders and RSpec](#rails-preloaders-and-rspec)
-* [Using Without Bundler](#using-without-bundler)
+- [Defining factories](#defining-factories)
+  - [Factory name and attributes](#factory-name-and-attributes)
+  - [Specifying the class explicitly](#specifying-the-class-explicitly)
+  - [Hash attributes](#hash-attributes)
+  - [Best practices](#best-practices)
+  - [Definition file paths](#definition-file-paths)
+  - [Static Attributes](#static-attributes)
+- [Using factories](#using-factories)
+  - [Build strategies](#build-strategies)
+  - [Attribute overrides](#attribute-overrides)
+  - [build\_stubbed and Marshal.dump](#build_stubbed-and-marshaldump)
+- [Aliases](#aliases)
+- [Dependent Attributes](#dependent-attributes)
+- [Transient Attributes](#transient-attributes)
+  - [With other attributes](#with-other-attributes)
+  - [With attributes\_for](#with-attributes_for)
+  - [With callbacks](#with-callbacks)
+  - [With associations](#with-associations)
+- [Method Name / Reserved Word Attributes](#method-name--reserved-word-attributes)
+- [Inheritance](#inheritance)
+  - [Nested factories](#nested-factories)
+  - [Assigning parent explicitly](#assigning-parent-explicitly)
+  - [Best practices](#best-practices-1)
+- [Associations](#associations)
+  - [Implicit definition](#implicit-definition)
+  - [Explicit definition](#explicit-definition)
+  - [Inline definition](#inline-definition)
+  - [Specifying the factory](#specifying-the-factory)
+  - [Overriding attributes](#overriding-attributes)
+  - [Association overrides](#association-overrides)
+  - [Build strategies](#build-strategies-1)
+  - [has\_many associations](#has_many-associations)
+  - [has\_and\_belongs\_to\_many associations](#has_and_belongs_to_many-associations)
+  - [Polymorphic associations](#polymorphic-associations)
+  - [Interconnected associations](#interconnected-associations)
+- [Sequences](#sequences)
+  - [Global sequences](#global-sequences)
+  - [With dynamic attributes](#with-dynamic-attributes)
+  - [As implicit attributes](#as-implicit-attributes)
+  - [Inline sequences](#inline-sequences)
+  - [Initial value](#initial-value)
+  - [Without a block](#without-a-block)
+  - [Aliases](#aliases-1)
+  - [Rewinding](#rewinding)
+  - [Uniqueness](#uniqueness)
+- [Traits](#traits)
+  - [Defining traits](#defining-traits)
+  - [As implicit attributes](#as-implicit-attributes-1)
+  - [Attribute precedence](#attribute-precedence)
+  - [In child factories](#in-child-factories)
+  - [As mixins](#as-mixins)
+  - [Using traits](#using-traits)
+  - [With associations](#with-associations-1)
+  - [Traits within traits](#traits-within-traits)
+  - [With transient attributes](#with-transient-attributes)
+  - [Enum traits](#enum-traits)
+- [Callbacks](#callbacks)
+  - [Default callbacks](#default-callbacks)
+  - [Multiple callbacks](#multiple-callbacks)
+  - [Global callbacks](#global-callbacks)
+  - [Symbol#to\_proc](#symbolto_proc)
+- [Modifying factories](#modifying-factories)
+- [Building or Creating Multiple Records](#building-or-creating-multiple-records)
+- [Linting Factories](#linting-factories)
+- [Custom Construction](#custom-construction)
+- [Custom Strategies](#custom-strategies)
+- [Custom Callbacks](#custom-callbacks)
+- [Custom Methods to Persist Objects](#custom-methods-to-persist-objects)
+- [ActiveSupport Instrumentation](#activesupport-instrumentation)
+- [Rails Preloaders and RSpec](#rails-preloaders-and-rspec)
+- [Using Without Bundler](#using-without-bundler)
 
 Setup
 -----
@@ -354,7 +355,7 @@ user = build(:user, account:, friends:)
 
 [omitting values]: https://docs.ruby-lang.org/en/3.1/syntax/literals_rdoc.html#label-Hash+Literals
 
-### `build_stubbed` and `Marshal.dump`
+### build_stubbed and Marshal.dump
 
 Note that objects created with `build_stubbed` cannot be serialized with
 `Marshal.dump`, since factory\_bot defines singleton methods on these objects.
@@ -435,7 +436,7 @@ create(:user, rockstar: false).name
 #=> "John Doe"
 ```
 
-### With `attributes_for`
+### With attributes_for
 
 Transient attributes will be ignored within attributes\_for and won't be set on
 the model, even if the attribute exists or you attempt to override it.
@@ -735,7 +736,7 @@ factory :post do
   author strategy: :build    # <<< this does *not* work; causes author_id to be nil
 ```
 
-### `has_many` associations
+### has_many associations
 
 There are a few ways to generate data for a `has_many` relationship. The
 simplest approach is to write a helper method in plain Ruby to tie together the
@@ -862,7 +863,7 @@ build(:user_with_posts, posts_count: 15).posts.length # 15
 build_stubbed(:user_with_posts, posts_count: 15).posts.length # 15
 ```
 
-### `has_and_belongs_to_many` associations
+### has_and_belongs_to_many associations
 
 Generating data for a `has_and_belongs_to_many` relationship is very similar
 to the above `has_many` relationship, with a small change: you need to pass an

README.md

@@ -1,20 +1,17 @@
-# factory_bot [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
+# factory_bot 
+
+[![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
 
 factory_bot is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
 
 If you want to use factory_bot with Rails, see
 [factory_bot_rails](https://github.com/thoughtbot/factory_bot_rails).
 
-_[Interested in the history of the project name?][NAME]_
-
-
-### Transitioning from factory\_girl?
+Interested in the history of the project name? You can find the history [here](https://github.com/thoughtbot/factory_bot/blob/main/NAME.md)
 
-Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/v4.9.0/UPGRADE_FROM_FACTORY_GIRL.md).
+Transitioning from factory\_girl? Check out the [upgrade guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stable/UPGRADE_FROM_FACTORY_GIRL.md).
 
-
-Documentation
--------------
+## Documentation
 
 See our extensive reference, guides, and cookbook in [the factory_bot book][].
 
@@ -27,8 +24,7 @@ Rails, see [the factory_bot wiki][].
 [the factory_bot book]: https://thoughtbot.github.io/factory_bot
 [the factory_bot wiki]: https://github.com/thoughtbot/factory_bot/wiki
 
-Install
---------
+## Install
 
 Run:
 
@@ -42,24 +38,20 @@ To install the gem manually from your shell, run:
 gem install factory_bot
 ```
 
-Supported Ruby versions
------------------------
+## Supported Ruby versions
 
-Supported Ruby versions are listed in [`.github/workflows/build.yml`](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml)
+Supported Ruby versions are listed in `.github/workflows/build.yml` ([source](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml))
 
-More Information
-----------------
+## More Information
 
 * [Rubygems](https://rubygems.org/gems/factory_bot)
 * [Stack Overflow](https://stackoverflow.com/questions/tagged/factory-bot)
 * [Issues](https://github.com/thoughtbot/factory_bot/issues)
 * [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](https://robots.thoughtbot.com/)
 
 [GETTING_STARTED]: https://github.com/thoughtbot/factory_bot/blob/main/GETTING_STARTED.md
-[NAME]: https://github.com/thoughtbot/factory_bot/blob/main/NAME.md
 
-Useful Tools
-------------
+## Useful Tools
 
 * [FactoryTrace](https://github.com/djezzzl/factory_trace) - helps to find unused factories and traits.
 * [ruby-lsp-factory_bot](https://github.com/donny741/ruby-lsp-factory_bot) / [ruby-lsp-rails-factory-bot](https://github.com/johansenja/ruby-lsp-rails-factory-bot) - integration with [ruby-lsp](https://github.com/Shopify/ruby-lsp) to provide intellisense