Skip to content

Conversation

@toshimaru
Copy link
Member

@toshimaru toshimaru commented Sep 27, 2025

This pull request updates documentation across several files to improve clarity and consistency by adding cross-references to code identifiers and correcting formatting in options lists. The changes help readers navigate the documentation more easily and ensure that referenced methods, classes, and modules are linked appropriately.

Improved cross-referencing in documentation

  • Added links to referenced methods, classes, and modules within documentation descriptions and examples, such as linking to expire_fragment, ActionController::API, and ActionController::Base in their respective docs. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]

Formatting and clarity improvements

  • Corrected formatting in options lists for method documentation, ensuring that option names are properly enclosed in <dt> tags for better readability. [1] [2]
  • Improved example code and descriptions by removing unnecessary code formatting around method names when not needed, clarifying which methods are callable, and updating references to match documentation conventions. [1] [2] [3]

@toshimaru toshimaru marked this pull request as ready for review September 27, 2025 20:09
Copilot AI review requested due to automatic review settings September 27, 2025 20:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@toshimaru toshimaru requested a review from Copilot September 27, 2025 20:23
@toshimaru toshimaru self-assigned this Sep 27, 2025
@toshimaru toshimaru enabled auto-merge (squash) September 27, 2025 20:26
@toshimaru toshimaru disabled auto-merge September 27, 2025 20:31
@toshimaru toshimaru merged commit 1d9e350 into railsdoc:main Sep 27, 2025
10 checks passed
@toshimaru toshimaru deleted the rebuild-rails-v7 branch September 27, 2025 20:32
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