8000 [jQuery] Fixed documentation URLs to JSDoc by AnnAngela · Pull Request #25235 · DefinitelyTyped/DefinitelyTyped · GitHub
[go: up one dir, main page]
Skip to content

[jQuery] Fixed documentation URLs to JSDoc #25235

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

[jQuery] Fixed documentation URLs to JSDoc #25235

wants to merge 2 commits into from

Conversation

AnnAngela
Copy link
@AnnAngela AnnAngela commented Apr 23, 2018 •
edited
Loading
  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Test the change in your own code. (Compile and run.)
  • Add or edit tests to reflect the change. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

This PR only applied a change to fix a bug noticed by microsoft/TypeScript#16498, to make the link in JSDoc parsed correctly in VSCode.
This change is only a batch replacement base on regular expressions(\{@link https?(:\/\/api\.jquery\.com\/)([^\/]+)\/[^\}]*\} 8000 => [$2](https$1$2/)), so maybe there are some links using incorrect title.
This change also fix the link using http protocol to https.

Before the edit:
Before the edit
After the edit:
After the edit:
(Please forgive my poor English:)

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Awaiting reviewer feedback labels Apr 23, 2018
@typescript-bot
Copy link
Contributor
typescript-bot commented Apr 23, 2018 •
edited
Loading

@AnnAngela Thank you for submitting this PR!

🔔 @leonard-thieu @borisyankov @choffmeister @Steve-Fenton @Diullei @tasoili @jasons-novaleaf @seanski @Guuz @ksummerlin @basarat @nwolverson @derekcicerone @AndrewGaspar @seikichi @benjaminjackman @s093294 @JoshStrobl @johnnyreilly @DickvdBrink @King2500 - please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead.

@typescript-bot
Copy link
Contributor
typescript-bot commented Apr 24, 2018 •
edited
Loading

@AnnAngela The Travis CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

@AnnAngela
Copy link
Author
AnnAngela commented Apr 26, 2018 •
edited
Loading

Hmmm
I could not understand what happened.
I didn't modify any code in types/jquery/test/longdesc-tests.ts, but when I didn't add the " on api.jquery.com" to the titles of the links, the test can be passed. After adding the " on api.jquery.com", I tried to copy the types/jquery/index.d.ts to another project to test if it works via VsCode, and it worked.
Anything wrong? Who can help me?

@typescript-bot
Copy link
Contributor

@AnnAngela I haven't seen anything from you in a while and this PR currently has problems that prevent it from being merged. The PR will be closed tomorrow if there aren't new commits to fix the issues.

@leonard-thieu
Copy link
Contributor
leonard-thieu commented Apr 30, 2018 •
edited
Loading

Breaks in typescript@next are handled by the TypeScript team.

This will be fixed by #25422.

leonard-thieu
leonard-thieu suggested changes Apr 30, 2018
View reviewed changes
Copy link
Contributor
@leonard-thieu leonard-thieu left a comment

Choose a reason for hiding this comment

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

This workaround breaks WebStorm's support for links. It'd be nice if there's a solution that works in both but otherwise, I think it's better if the bug in VS Code would be fixed instead.

@typescript-bot typescript-bot added Revision needed This PR needs code changes before it can be merged. Abandoned This PR had no activity for a long time, and is considered abandoned labels Apr 30, 2018
@typescript-bot
Copy link
Contributor

@AnnAngela To keep things tidy, we have to close PRs that aren't mergeable but don't have activity from their author. No worries, though - please open a new PR if you'd like to continue with this change. Thank you!

@leonard-thieu leonard-thieu mentioned this pull request Jun 11, 2018
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonard-thieu leonard-thieu leonard-thieu requested changes

@basarat basarat Awaiting requested review from basarat basarat is a code owner

@borisyankov borisyankov Awaiting requested review from borisyankov borisyankov is a code owner

@Diullei Diullei Awaiting requested review from Diullei Diullei is a code owner

@johnnyreilly johnnyreilly Awaiting requested review from johnnyreilly johnnyreilly is a code owner

Assignees
No one assigned
Labels
Abandoned This PR had no activity for a long time, and is considered abandoned Popular package This PR affects a popular package (as counted by NPM download counts). Revision needed This PR needs code changes before it can be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AnnAngela @typescript-bot @leonard-thieu
0