Skip to content

Conversation

@toshimaru
Copy link
Member

@toshimaru toshimaru commented Oct 21, 2025


This pull request updates the HTML documentation for methods in AbstractController::Base and AbstractController::Caching. The main change is a consistent formatting improvement: method headers now use inline code formatting to clearly display method signatures, making the documentation easier to read and scan.

Documentation formatting improvements:

  • All method headers in src/classes/AbstractController/Base.html now use <code><b>method_name</b>(...)</code> for both class and instance methods, replacing the previous multi-line format. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]
  • The same formatting update is applied to the view_cache_dependencies and cache methods in src/classes/AbstractController/Caching.html, improving consistency across documentation. [1] [2]
  • Extra whitespace and redundant markup in method header sections have been removed, resulting in cleaner HTML output. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]

These changes are purely presentational and do not affect any code logic or behavior.

@toshimaru toshimaru marked this pull request as ready for review October 24, 2025 00:12
Copilot AI review requested due to automatic review settings October 24, 2025 00:12
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.

Pull Request Overview

This PR updates the documentation by regenerating it with a new version of sdoc. The changes primarily involve reformatting method signatures in HTML documentation files, consolidating multi-line method headers into single-line format with inline code formatting, and updating alias reference links to use a more structured format.

Key changes:

  • Method signature formatting consolidated from multi-line to single-line with <code> tags
  • Removal of empty description divs for methods without documentation
  • Alias reference links updated to use structured <p class="method__aka"> format with full paths

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@toshimaru toshimaru merged commit 9f810b1 into railsdoc:main Oct 24, 2025
11 checks passed
@toshimaru toshimaru deleted the update-sdoc-20251021 branch October 24, 2025 00:13
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