docs: Generate docs with new sdoc#199
Merged
toshimaru merged 1 commit intorailsdoc:mainfrom Oct 24, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
description_for,description_for,link_to,link_to_iftoshimaru/sdoc#13This pull request updates the HTML documentation for methods in
AbstractController::BaseandAbstractController::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:
src/classes/AbstractController/Base.htmlnow 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]view_cache_dependenciesandcachemethods insrc/classes/AbstractController/Caching.html, improving consistency across documentation. [1] [2]These changes are purely presentational and do not affect any code logic or behavior.