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

feat: display multiple symbol kinds as a single symbol #50

Merged
merged 1 commit into from Nov 23, 2022

Conversation

crowlKats
Copy link
Member

@crowlKats crowlKats commented Nov 22, 2022

Closes denoland/dotland#2483
Screenshot 2022-11-22 at 13 48 59

Example previews:
library index: https://dotland-pcw2qz4nw9s0.deno.dev/api@v1.28.1
library sidepanel: https://dotland-pcw2qz4nw9s0.deno.dev/api@v1.28.1?s=FormData
module sidepanel: https://dotland-pcw2qz4nw9s0.deno.dev/x/zod@v3.18.0/mod.ts?s=ZodIssueCode

The only problem with this is that module index (https://dotland-pcw2qz4nw9s0.deno.dev/x/zod@v3.18.0/mod.ts) is sectioned by symbol kind, so it could be weird if we do this there.

@crowlKats crowlKats marked this pull request as draft November 22, 2022 12:49
@kt3k
Copy link
Member

kt3k commented Nov 22, 2022

Visually looks great to me

@crowlKats crowlKats marked this pull request as ready for review November 23, 2022 07:45
Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

LGTM

category?: string;
jsDoc?: JsDoc | null;
}

export function categorize(
Copy link
Member

Choose a reason for hiding this comment

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

This looks highly complex now. Let's add some test cases later #51

@crowlKats crowlKats merged commit 574e48b into main Nov 23, 2022
@crowlKats crowlKats deleted the merge_multiple_symbol_in_indexes branch November 23, 2022 08:30
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.

doc display of symbols with multiple types
2 participants