Skip to content

Fix @link https:// formatting #47705

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

Merged
merged 2 commits into from
Feb 2, 2022
Merged

Fix @link https:// formatting #47705

merged 2 commits into from
Feb 2, 2022

Conversation

sandersn
Copy link
Member

@sandersn sandersn commented Feb 2, 2022

Also improve .d.ts formatting of @link,@linkcode,@linkplain.

Fixes #46734

  1. Previously, @link incorrectly put a space between "https" and "://" when formatting jsdoc for editors. Now it does not.
  2. When fixing the same output for .d.ts, I discovered that all @link tags were formatted as @link, even if they were @linkcode or @linkplain. I fixed that too.

Also improve .d.ts formatting of `@link`,`@linkcode`,`@linkplain`.

Fixes #46734

1. Previously, `@link` incorrectly put a space between "https" and "://"
when formatting jsdoc for editors. Now it does not.
2. When fixing the same output for .d.ts, I discovered that all `@link` tags
were formatted as `@link`, even if they were `@linkcode` or
`@linkplain`. I fixed that too.
@typescript-bot typescript-bot added Author: Team For Milestone Bug PRs that fix a bug with a specific milestone labels Feb 2, 2022
@sandersn
Copy link
Member Author

sandersn commented Feb 2, 2022

Note that the .d.ts formatting code is duplicated with the services formatting; the former doesn't do name resolution so doesn't require a checker, and I don't really think proper .d.ts comment formatting is high enough priority to extract the common parts of the code to compiler/utilities.ts. Maybe it is though! Let me know what you think.

Copy link
Member

@jakebailey jakebailey left a comment

Choose a reason for hiding this comment

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

LGTM other than the lint checks

@sandersn
Copy link
Member Author

sandersn commented Feb 2, 2022

Oops, forgot to re-run gulp lint --fix after working on utilitiesPublic.ts.

@sandersn sandersn merged commit c4fd002 into main Feb 2, 2022
@sandersn sandersn deleted the fix-link-https-formatting branch February 2, 2022 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author: Team For Milestone Bug PRs that fix a bug with a specific milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jsdoc https @link text not parsed properly
4 participants