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

docs: shared-options applies twoslash #16337

Closed
wants to merge 1 commit into from

Conversation

btea
Copy link
Collaborator

@btea btea commented Apr 3, 2024

Description

Supplement #16168, some examples on the shared-options page apply twoslash.

Copy link

stackblitz bot commented Apr 3, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@btea btea requested a review from sapphi-red April 6, 2024 08:04
@sapphi-red
Copy link
Member

I didn't add it to these code blocks because I thought it will be distracting. But I don't have that strong opinion. I'll let others chime in about this.

@sapphi-red sapphi-red added the documentation Improvements or additions to documentation label Apr 8, 2024
@patak-dev
Copy link
Member

I tested these code snippets and I agree with @sapphi-red here. The information is the same as the paragraph above in some cases, and not that relevant in others (like JSON or stringify). Let's keep it without twoslash for now. One point in favor is the expectation from users to see the overlays though, so we can review this again in the future. If every other snippet has it, maybe all of them needs to have it.

@patak-dev patak-dev closed this Apr 8, 2024
@btea
Copy link
Collaborator Author

btea commented Apr 9, 2024

Thank you for your detailed explanation.

@btea btea deleted the docs/shared-options-twoslash branch April 9, 2024 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants