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.

Sign up for GitHub

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

Jump to bottom

doc link is broken #12018

Open
rdp opened this issue Apr 21, 2022 · 3 comments · Fixed by #14910
Open

doc link is broken #12018

rdp opened this issue Apr 21, 2022 · 3 comments · Fixed by #14910
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:docs topic:tools:docs-generator

Comments

@rdp
Copy link
Contributor

rdp commented Apr 21, 2022

On this page:

https://crystal-lang.org/api/1.4.0/File.html

The link to Crystal::System::File methods (ex: #open) seems to go to a 404. Thanks.
@rdp rdp added the kind:bug A bug in the code. Does not apply to documentation, specs, etc. label Apr 21, 2022
@Blacksmoke16
Copy link
Member

Thought this would have been fixed via #9819, given it's in a :nodoc: namespace: https://github.com/crystal-lang/crystal/blob/master/src/crystal/system.cr#L1.

Either way, this is related to #9816 in that its trying to link to a non-public type.

@dentarg
Copy link

dentarg commented Aug 14, 2024

Also fixed by #14878?

@Blacksmoke16 Blacksmoke16 linked a pull request Aug 14, 2024 that will close this issue
Fix: Don't link to undocumented types in API docs #14878
Merged
@Blacksmoke16 Blacksmoke16 mentioned this issue Aug 14, 2024
Merged
@spuun spuun mentioned this issue Aug 15, 2024
Merged
@Blacksmoke16 Blacksmoke16 reopened this Aug 15, 2024
@Blacksmoke16 Blacksmoke16 linked a pull request Aug 15, 2024 that will close this issue
Add nodoc filter to doc type methods #14910
Merged
@Blacksmoke16 Blacksmoke16 removed a link to a pull request Aug 15, 2024
Fix: Don't link to undocumented types in API docs #14878
Merged
@straight-shoota straight-shoota mentioned this issue Oct 7, 2024
Merged
@straight-shoota
Copy link
Member

#14878 got reverted. So we need to reopen this again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:docs topic:tools:docs-generator
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add nodoc filter to doc type methods spuun/crystal
4 participants
@rdp @dentarg @straight-shoota @Blacksmoke16