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

Format markdown files consistently with MLIR-HLO #128

Merged
merged 1 commit into from
Sep 15, 2022
Merged

Format markdown files consistently with MLIR-HLO #128

merged 1 commit into from
Sep 15, 2022

Conversation

burmako
Copy link
Contributor

@burmako burmako commented Sep 15, 2022

Wrap at 80 characters, use headers correctly (no more than one level-one header in one file).

Wrap at 80 characters, use headers correctly (no more than one level-one
header in one file).
@burmako burmako added the Build label Sep 15, 2022
@burmako burmako requested a review from GleasonK September 15, 2022 02:31
Copy link
Member

@GleasonK GleasonK left a comment

Choose a reason for hiding this comment

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

Is this for "Format markdown files" or "Format README files". I'm surprised nothing in the doc folder has changed if this is for all markdown files (unless we have a standard that we adhered to)

Is there any tool we can use for this? We could add a lint check to error if an MD file is different when broken at 80 characters:

diff README.md <(fmt -w 80 -s README.md)

Advising running <some bash command> to auto-fix the file formatting.

@burmako burmako merged commit a11bb4b into openxla:main Sep 15, 2022
@burmako burmako deleted the markdown branch September 15, 2022 20:40
@burmako burmako mentioned this pull request Sep 15, 2022
@burmako burmako self-assigned this Oct 2, 2022
GleasonK pushed a commit to GleasonK/stablehlo that referenced this pull request Nov 10, 2022
Wrap at 80 characters, use headers correctly (no more than one level-one
header in one file).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants