docs: add TSDoc comment to GitHubReviewers interface - #1520
Merged
orta merged 1 commit intoJul 27, 2026
Conversation
Closes #1409. The DSL reference doc generator (typedoc) only emits a dedicated section for exported interfaces that have a leading TSDoc comment. GitHubReviewers lacked one, so it was silently dropped from the generated reference even though it's referenced from GitHubJSONDSL.requested_reviewers.
fbartho
approved these changes
Jul 8, 2026
Contributor
Author
|
Gentle nudge on this one — approved by @fbartho on 8 July, CI green, no conflicts. It's a 3-line doc comment on @orta, you've been handling merges here (#1522 went in on the 15th) — could this get picked up when you next do a pass? No rush if it's waiting on a release cycle. |
Member
|
Yeah, seems fine to me 👍🏻 |
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
3 participants
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.
Summary
Closes #1409.
GitHubReviewers(referenced fromGitHubJSONDSL.requested_reviewers) had no top-level TSDoc comment, so it was silently dropped from the generated DSL Reference page — typedoc only emits a dedicated section for exported interfaces/types that have a leading doc comment. Other documented interfaces in the same file (e.g.GitHubUser) already follow this pattern.Change
Added a one-line TSDoc block above
export interface GitHubReviewersinsource/dsl/GitHubDSL.ts, mirroring the style used forGitHubUser.Test plan
npx tsc --noEmitpassesnpx eslint source/dsl/GitHubDSL.tspasses with no warnings