Skip to content
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

[DOC] Fix links in doc #9970

Merged
merged 4 commits into from Feb 20, 2024
Merged

[DOC] Fix links in doc #9970

merged 4 commits into from Feb 20, 2024

Conversation

BurdetteLamar
Copy link
Member

No description provided.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Feb 14, 2024
dir.c Outdated
@@ -3689,7 +3689,7 @@ Init_Dir(void)
* {File::FNM_SYSCASE}[rdoc-ref:File::Constants@File-3A-3AFNM_SYSCASE] */
rb_file_const("FNM_SYSCASE", INT2FIX(FNM_SYSCASE));
/* Document-const: FNM_SHORTNAME
* {File::FNM_SHORTNAME}[rdoc-ref:File::Constants@File-3A-3AFNM_SHORTNAME] */
* {File::FNM_SHORTNAME}[rdoc-ref:File::Constants@File-3A-3AFNM_SHORTNAME+-28Windows+Only-29] */
Copy link
Member

Choose a reason for hiding this comment

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

I'd rather propose moving "(Windows Only)" from the heading to its content.

     * ==== File::FNM_SHORTNAME
     *
     * Flag File::FNM_SHORTNAME Allows patterns to match short names if they exist.
     * (Windows Only).

Copy link
Member Author

Choose a reason for hiding this comment

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

Heading and link fixed, along with one other similar header and its link.

Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

Why is there an empty file doc/field_processing.md created?

io.c Show resolved Hide resolved
@BurdetteLamar
Copy link
Member Author

Why is there an empty file doc/field_processing.md created?

Error; removed.

* see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit].
* With arguments +sep+ and +limit+ given,
* combines the two behaviors
* (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]).
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this link exists.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have to figure this out. I have that section in io.c on my branch links_repair; the file is not showing as modified or staged, and committing and/or pushing does nothing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I see the section in https://github.com/ruby/ruby/blob/2f29d42f1c7eb2a9294b9c818745d78b0b18da13/io.c, line 15221. On my machine, RDoc builds valid links to this heading. Link does not exist or does not work for you?

Copy link
Member

Choose a reason for hiding this comment

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

Ah I see you added it back in 2f29d42.

@peterzhu2118 peterzhu2118 merged commit d4b4b53 into ruby:master Feb 20, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
3 participants