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

Fix broken markdown in Windows-specific docs. #42606

Merged
merged 1 commit into from
Oct 14, 2021
Merged

Conversation

maleadt
Copy link
Member

@maleadt maleadt commented Oct 12, 2021

@maleadt maleadt added the docs This change adds or pertains to documentation label Oct 12, 2021
@maleadt maleadt requested a review from fredrikekre October 12, 2021 15:01
@fredrikekre
Copy link
Member

Huh, the Markdown stdlib doesn't understand this version, hence why I updated them, but looks like GitHub behaves the opposite. I guess the only way to make it work on both is to put it all on a single line.

@maleadt maleadt force-pushed the tb/windows_urls branch 2 times, most recently from 1a6822a to fe1bcec Compare October 13, 2021 08:59
@maleadt
Copy link
Member Author

maleadt commented Oct 13, 2021

OK, I've reflowed them such that ](...) always occurs on a single line (which is what VSCode makes of it by default). Still renders OK in GitHub, https://github.com/JuliaLang/julia/blob/fe1bcec239e002e3c5ae4798d5d430f0383a2997/doc/src/devdocs/build/windows.md, and also seems to works fine with Markdown.parse.

@fredrikekre fredrikekre reopened this Oct 13, 2021
@DilumAluthge
Copy link
Member

You won't be able to merge this because:

  1. The whitespace check is required for merging to master. (This is useful because, for example, it prevents people from accidentally committing directly to master.)
  2. Your commit message has "ci skip" in it, so Buildkite won't start.

Either push a commit that doesn't have "ci skip", or amend your last commit and remove "ci skip" from the commit message.

@maleadt
Copy link
Member Author

maleadt commented Oct 14, 2021

That's a waste of CI time, but OK. I'll amend the commit.

@DilumAluthge
Copy link
Member

@maleadt @staticfloat What do you think the best way forward here is? I like having the whitespace check as a required check, because it keeps people from accidentally committing directly to master.

Personally, I would rather waste a bit of CI time (by telling people they can't do [ci skip]) instead of removing the whitespace check from the list of required checks.

@fredrikekre
Copy link
Member

Back in the Travis days we had this: #27356

@DilumAluthge
Copy link
Member

Back in the Travis days we had this: #27356

I'll look into this further.

@fredrikekre fredrikekre merged commit 7c5e28c into master Oct 14, 2021
@fredrikekre fredrikekre deleted the tb/windows_urls branch October 14, 2021 13:01
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Feb 22, 2022
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Mar 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants