Skip to content

Fix mark method overrides on ExecutionContext as :nodoc:#15659

Merged
straight-shoota merged 1 commit intocrystal-lang:masterfrom
ysbaddaden:fix/execution-context-nodoc-defs
Apr 15, 2025
Merged

Fix mark method overrides on ExecutionContext as :nodoc:#15659
straight-shoota merged 1 commit intocrystal-lang:masterfrom
ysbaddaden:fix/execution-context-nodoc-defs

Conversation

@ysbaddaden
Copy link
Collaborator

The documentation of descendant defs is taken from the parent abstract defs that contain :nodoc: and the docs generator doesn't recognizes :nodoc: from the copy. This led to internal methods being documented as :nodoc:.

@ysbaddaden ysbaddaden added this to the 1.16.1 milestone Apr 14, 2025
@ysbaddaden ysbaddaden self-assigned this Apr 14, 2025
@straight-shoota
Copy link
Member

Maybe the doc generator should imply that. But this could lead to unexpected behaviour? Anyway, an explicit :nodoc: on the actual def makes it very clear.

@ysbaddaden ysbaddaden moved this from Review to Approved in Multi-threading Apr 14, 2025
@straight-shoota straight-shoota changed the title Fix: some execution contexts methods are documented as :nodoc: Fix mark method overrides on ExecutionContext as :nodoc: Apr 15, 2025
@straight-shoota straight-shoota merged commit 57524cf into crystal-lang:master Apr 15, 2025
35 of 36 checks passed
@github-project-automation github-project-automation bot moved this from Approved to Done in Multi-threading Apr 15, 2025
@ysbaddaden ysbaddaden deleted the fix/execution-context-nodoc-defs branch April 28, 2025 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants