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

Nit: Fix links in NEWS.md by running NEWS-update.jl #30474

Merged
merged 1 commit into from
Dec 21, 2018

Conversation

NHDaly
Copy link
Member

@NHDaly NHDaly commented Dec 20, 2018

Fixes the out-of-date hyperlinks on NEWS.md.

It looks like that step was missed on #30061 and #30200

Fixes the out-of-date hyperlinks on NEWS.md.
@ararslan
Copy link
Member

It's really only necessary to do right before a release, but it's also fine to do earlier.

@stevengj
Copy link
Member

(We don't generally do it in the PRs themselves because it creates lots of spurious conflicts between PRs. But it is fine to have occasional separate PRs just to update the links.)

@stevengj stevengj merged commit c8c48a2 into JuliaLang:master Dec 21, 2018
@NHDaly NHDaly deleted the patch-3 branch December 21, 2018 02:31
@NHDaly
Copy link
Member Author

NHDaly commented Dec 21, 2018

Ah, makes sense. Thanks for explaining that, @stevengj.

Should i remove that step from the CONTRIBUTING.md? It currently says:

The news item should cross reference the pull request (PR) parenthetically, in the form ([#pr]); after adding this, run ./julia doc/NEWS-update.jl from the julia directory to update the cross-reference links.

@stevengj
Copy link
Member

Yes, it should probablybe changed to something like:

The news item should cross reference the pull request (PR) parenthetically, in the form ([#pr]). We periodically run ./julia doc/NEWS-update.jl from the julia directory to update the cross-reference links, but this should not be done in a typical PR in order to avoid conflicting commits.

@NHDaly
Copy link
Member Author

NHDaly commented Dec 21, 2018

Thanks @stevengj. I've changed that here: #30482

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.

None yet

3 participants