Skip to content

Use {class_module,file}_path_prefix RDoc options #376

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

Merged
merged 2 commits into from
Mar 30, 2025

Conversation

jonathanhefner
Copy link
Member

@jonathanhefner jonathanhefner commented Mar 25, 2025

Follow-up to #375.

RDoc 6.13.1 has been released, and includes support for the class_module_path_prefix and file_path_prefix options (added in ruby/rdoc@3bc179d), which serve as replacements for the class_dir and file_dir methods.

This commit removes the RDoc monkey patch added in e2d849f in favor of using those options. This means SDoc will be incompatible with RDoc 6.13.0 specifically, but that shouldn't be a significant issue (and compatibility with RDoc < 6.13.0 is preserved).

@jonathanhefner jonathanhefner force-pushed the rdoc-path-prefix-options branch from a48a8dc to f725cfd Compare March 25, 2025 16:07
Follow-up to rails#375.

RDoc 6.13.1 has been released, and includes support for the
`class_module_path_prefix` and `file_path_prefix` options (added in
ruby/rdoc@3bc179d), which serve as
replacements for the `class_dir` and `file_dir` methods.

This commit removes the RDoc monkey patch added in
e2d849f in favor of using those
options.  This means SDoc will be incompatible with RDoc 6.13.0
specifically, but that shouldn't be a significant issue (and
compatibility with RDoc < 6.13.0 is preserved).
@jonathanhefner jonathanhefner force-pushed the rdoc-path-prefix-options branch from f725cfd to 0daa0ba Compare March 30, 2025 17:41
@jonathanhefner jonathanhefner changed the title Use RDoc *_path_prefix options Use {class_module,file}_path_prefix RDoc options Mar 30, 2025
On machines configured to be in UTC (such as CI servers), git may format
timestamps with a "Z" suffix rather than "+HH:MM".
@jonathanhefner jonathanhefner marked this pull request as ready for review March 30, 2025 18:04
@jonathanhefner jonathanhefner merged commit 141f755 into rails:main Mar 30, 2025
10 checks passed
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