[WIP] docs: Disable Go reformatting #961
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abhinav
force-pushed
the
abg/tutorial-nogofmt
branch
from
930051c to
5aa4553
Compare
This temporarily pins to my fork of mdox to include bwplotka/mdox#98. Separately, this upgrades markdownfmt to pick up Kunde21/markdownfmt#38. These two combined add the ability for us to opt out of mdox reformatting all Go code blocks inside Markdown files. The .gitignore change is added because this version of mdox uses a local sqlite cache for speed.
Disable reformatting of Go code by mdox because it produces wildly inconsistent output.
abhinav
force-pushed
the
abg/tutorial-nogofmt
branch
from
5aa4553 to
35eb038
Compare
Codecov Report
@@ Coverage Diff @@
## master #961 +/- ##
=======================================
Coverage 98.62% 98.62%
=======================================
Files 38 38
Lines 1529 1529
=======================================
Hits 1508 1508
Misses 15 15
Partials 6 6 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
mway
approved these changes
Oct 19, 2022
|
Closing in favor of #1000 |
sywhang
pushed a commit
that referenced
this pull request
Dec 12, 2022
(This is a new version of #961. I can't push to the original branch anymore.) --- Upgrade to latest markdownfmt which does not reformat Go source code blocks by default. With this change, formatting of code blocks in Fx docs will be consistent instead of some being gofmt-ed to use tabs, and others using 2 spaces (per our 'region' script). This is a landable version of #961 without any temporary version pins.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Disable reformatting of Go code by mdox because it produces wildly
inconsistent output.
Depends on #958
This PR temporarily pins to my fork of mdox to include bwplotka/mdox#98,
and updates markdownfmt to include Kunde21/markdownfmt#38.
These two combined add the ability for us to opt out of mdox
reformatting all Go code blocks inside Markdown files.