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 formatting for markdown files #80

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RaduNichita
Copy link
Contributor

The PR fix formatting for markdown. Partially fix #79

Signed-off-by: Radu Nichita <radunichita99@gmail.com>
Copy link
Member

@neatudarius neatudarius left a comment

Choose a reason for hiding this comment

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

LGTM, but is markdownlint happy with current status?

I think we should add markdownlint config to this repo (check https://github.com/bemanproject/exemplar/blob/main/.markdownlint.yaml) and a simple CI file which runs only this tool.
It's OK to have a clean main today, but how about automated check?

I'm OK to do a follow-up PR in the same issue.

Copy link
Member

@steve-downey steve-downey left a comment

Choose a reason for hiding this comment

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

LGTM

(for emacs users - adaptive-fill-mode and visual-fill-column are how to handle word processing style wrapping for markup languages)

@wusatosi
Copy link
Member

wusatosi commented Dec 18, 2024

Hey is there a reason this is created/ would be preferred over #62 ?
Formatting commits messes up git blame greatly, I don't want to cause too much formatting commits.

I think we should add markdownlint config to this repo (check https://github.com/bemanproject/exemplar/blob/main/.markdownlint.yaml) and a simple CI file which runs only this tool. It's OK to have a clean main today, but how about automated check?

I'm OK to do a follow-up PR in the same issue.

This is already implemented in #62 with review from @camio . With formatting done to other markdowns (e.g. docs/BEMAN_STANDARD.md) and misc files. I am simply waiting for a decision on if we should include git blame ignore file.

cc @neatudarius @steve-downey

Copy link
Member

@wusatosi wusatosi left a comment

Choose a reason for hiding this comment

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

We need to figure out the relationship between this PR to #62 , see above comment.

There's still spaces at end-of-line, see patch:

patch
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
index 118c837..ead0765 100644
--- a/docs/CODE_OF_CONDUCT.md
+++ b/docs/CODE_OF_CONDUCT.md
@@ -99,7 +99,7 @@ spaces:
     Maybe meet over VC (video call) instead.
     Switching approaches can help resume progress.
 
-No weapons are allowed at Beman Project events. 
+No weapons are allowed at Beman Project events.
 Weapons include, but are not limited to, explosives (including fireworks), guns, and large knives such as those used
 for hunting or display, as well as any other item used for the purpose of causing injury or harm to others.
 
@@ -125,22 +125,22 @@ If you believe someone is violating the code of conduct, you can report it to th
 **All reports will be kept confidential**, and are only used by the conduct team
 to address conduct issues and keep the Beman Project community safe and inclusive.
 
-Please send reports concerning a member of the conduct team directly to other members of the conduct team. 
+Please send reports concerning a member of the conduct team directly to other members of the conduct team.
 This allows discussion of the complaint to more easily exclude the concerned member as a [special case](#special-cases).
 
 If you believe anyone is in **physical danger**, please notify appropriate law enforcement first.
 If you are unsure what law enforcement agency is appropriate, please include this in your report and we will attempt to notify them.
 
-If the violation occurs at an event and requires immediate attention, you can also reach out to any of the event organizers or staff. 
-Event organizers and staff will be prepared to handle the incident and be able to help. 
+If the violation occurs at an event and requires immediate attention, you can also reach out to any of the event organizers or staff.
+Event organizers and staff will be prepared to handle the incident and be able to help.
 If you cannot find one of the organizers, the venue staff can locate one for you.
 Specific event information will include detailed contact information for that event.
 In person reports will still be kept confidential exactly as above, but also feel free to email the conduct team, anonymously if needed.
 
 ### Filing a report
 
-Reports can be as formal or informal as needed for the situation at hand. 
-If possible, please include as much information as you can. 
+Reports can be as formal or informal as needed for the situation at hand.
+If possible, please include as much information as you can.
 If you feel comfortable, please consider including:
 
 *   Your contact info, so we can get in touch with you if we need to follow up.
@@ -166,13 +166,13 @@ The conduct team will review the incident as soon as possible and try to determi
     physical safety.
 
 If this is determined to be an ongoing incident or a threat to physical safety,
-the conduct team's immediate priority will be to protect everyone involved. 
+the conduct team's immediate priority will be to protect everyone involved.
 This means we may delay an "official" response until we believe that the situation has ended and that everyone is physically safe.
 
 The conduct team will try to contact other parties involved or witnessing the event to gain clarity on what happened and understand any different
 perspectives.
 
-Once the conduct team has a complete account of the events they will make a decision as to how to respond. 
+Once the conduct team has a complete account of the events they will make a decision as to how to respond.
 Responses may include:
 
 *   Nothing, if no violation occurred or it has already been appropriately resolved.
@@ -186,24 +186,24 @@ Once we’ve determined our response, we will separately contact the original re
 taking. We will take into account feedback from the individuals involved on the
 appropriateness of our response, but we don’t guarantee we’ll act on it.
 
-After any incident, the Beman Project leads may choose to make a public statement about the incident. 
+After any incident, the Beman Project leads may choose to make a public statement about the incident.
 If that’s the case, the identities of anyone involved will remain confidential unless instructed otherwise by those individuals.
 
 ### Appealing
 
-Only permanent resolutions, such as bans, or requests for public actions may be appealed. 
+Only permanent resolutions, such as bans, or requests for public actions may be appealed.
 To appeal a decision of the conduct team, contact the [Beman leads](GOVERNANCE.md) with your appeal and they will review the case.
 
 In general, it is **not** appropriate to appeal a particular decision in public
-areas of GitHub or Discord. 
-Doing so would involve disclosure of information which should remain confidential. 
-Disclosing this kind of information publicly may be considered a separate and, potentially, more serious violation of the Code of Conduct. 
+areas of GitHub or Discord.
+Doing so would involve disclosure of information which should remain confidential.
+Disclosing this kind of information publicly may be considered a separate and, potentially, more serious violation of the Code of Conduct.
 This is not meant to limit discussion of the Code of Conduct, the conduct team itself, or the appropriateness of responses in general, but **please** refrain from mentioning specific facts about cases without the explicit permission of all parties involved.
 
 ### Special cases
 
 If a complaint is raised against a member of the Beman Project leads, they will be excluded from conduct discussion and decisions, including appeals.
-They will only be included as needed for an involved party, such as to get their perspective or to notify them of decisions. 
+They will only be included as needed for an involved party, such as to get their perspective or to notify them of decisions.
 Such complaints may lead to a member's responsibilities being revoked.
 
 ## Enforcement action guidelines
@@ -219,7 +219,7 @@ involved:
         the code of conduct.
     *   **Action:** A private, written message providing clarity around the
         nature of the violation and an explanation of why the behavior was
-        inappropriate. 
+        inappropriate.
         A public apology may be requested.
 1.  **Warning**
     *   **Behavior:** A code of conduct violation through a single moderate
@@ -227,13 +227,13 @@ involved:
     *   **Action:** In addition to the correction action, a temporary
         restriction forbidding interaction with the people involved for a
         specified period of time, including unsolicited interaction with the
-        conduct team. 
+        conduct team.
         Violating these terms may lead to a ban.
 1.  **Temporary ban**
     *   **Behavior:** A serious violation of the code of conduct, including
         sustained inappropriate behavior.
     *   **Action:** In addition to the warning action, a temporary ban from use
-        of Beman Project's community spaces for a specified period of time. External channels, such as social media, should not be used to bypass these restrictions during the temporary ban. 
+        of Beman Project's community spaces for a specified period of time. External channels, such as social media, should not be used to bypass these restrictions during the temporary ban.
         Violating these terms may lead to a permanent ban.
 1.  **Permanent ban**
     *   **Behavior:** Demonstrating a pattern of violation of the code of
diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md
index a55a9b0..7b65b30 100644
--- a/docs/GOVERNANCE.md
+++ b/docs/GOVERNANCE.md
@@ -35,7 +35,7 @@ Beman Leads are currently: Jeff Garland, Inbal Levi, and David Sankel.
 
 ### 3.1.2 Adding and removing Beman Leads
 
-Any member of Beman Project Leads may step down or be replaced when they are no longer able to contribute effectively. 
+Any member of Beman Project Leads may step down or be replaced when they are no longer able to contribute effectively.
 The Beman Project Leads can nominate and decide on adding, removing, or replacing members by a majority decision.
 
 ## 3.2 Beman Project Contributors:
@@ -52,7 +52,7 @@ The Beman Project Library Authors are the Library authors who are maintaining an
 
 ### 3.3.3 Adding and removing Beman Project Library Authors:
 
-Beman Project Library Authors apply for acceptance into Beman Project when they have reached the point of path toward standardization. 
+Beman Project Library Authors apply for acceptance into Beman Project when they have reached the point of path toward standardization.
 This would be the submission of a Paper to the Committee, request to have a library to help write their paper, or a similar path.
 
 Removal as a Beman Project Library Author may be done when the library no longer becomes part of the Beman Project.
@@ -61,8 +61,8 @@ Removal as a Beman Project Library Author may be done when the library no longer
 
 # 4.1 Consensus Decision-Making:
 
-Beman Project strives to make decisions through consensus among the Project Contributors and the Project Leads.  
-Proposals on the best way to proceed should be discussed in good faith.  
+Beman Project strives to make decisions through consensus among the Project Contributors and the Project Leads.
+Proposals on the best way to proceed should be discussed in good faith.
 Beman Project Leads ultimately decide the direction of the Project.
 
 # 5. Code of Conduct

Markdownlint is still very much not happy after the format (CC @neatudarius ):

markdownlint report
docs/CODE_OF_CONDUCT.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 199]
docs/CODE_OF_CONDUCT.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 87]
docs/CODE_OF_CONDUCT.md:12:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:13:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:14:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:15:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:16:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:17:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:18:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:21:81 MD013/line-length Line length [Expected: 80; Actual: 130]
docs/CODE_OF_CONDUCT.md:24:81 MD013/line-length Line length [Expected: 80; Actual: 161]
docs/CODE_OF_CONDUCT.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 187]
docs/CODE_OF_CONDUCT.md:28:81 MD013/line-length Line length [Expected: 80; Actual: 128]
docs/CODE_OF_CONDUCT.md:35:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:39:81 MD013/line-length Line length [Expected: 80; Actual: 374]
docs/CODE_OF_CONDUCT.md:41:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 127]
docs/CODE_OF_CONDUCT.md:47:81 MD013/line-length Line length [Expected: 80; Actual: 150]
docs/CODE_OF_CONDUCT.md:49:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:51:81 MD013/line-length Line length [Expected: 80; Actual: 94]
docs/CODE_OF_CONDUCT.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 112]
docs/CODE_OF_CONDUCT.md:53:81 MD013/line-length Line length [Expected: 80; Actual: 117]
docs/CODE_OF_CONDUCT.md:55:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:57:81 MD013/line-length Line length [Expected: 80; Actual: 109]
docs/CODE_OF_CONDUCT.md:58:81 MD013/line-length Line length [Expected: 80; Actual: 108]
docs/CODE_OF_CONDUCT.md:60:81 MD013/line-length Line length [Expected: 80; Actual: 101]
docs/CODE_OF_CONDUCT.md:61:81 MD013/line-length Line length [Expected: 80; Actual: 110]
docs/CODE_OF_CONDUCT.md:64:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:67:81 MD013/line-length Line length [Expected: 80; Actual: 104]
docs/CODE_OF_CONDUCT.md:69:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:69:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:70:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:70:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:71:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:71:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:72:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:72:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:74:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:74:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:75:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:75:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:76:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:76:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:77:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/CODE_OF_CONDUCT.md:77:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:80:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:85:81 MD013/line-length Line length [Expected: 80; Actual: 105]
docs/CODE_OF_CONDUCT.md:87:81 MD013/line-length Line length [Expected: 80; Actual: 93]
docs/CODE_OF_CONDUCT.md:91:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:93:81 MD013/line-length Line length [Expected: 80; Actual: 89]
docs/CODE_OF_CONDUCT.md:95:81 MD013/line-length Line length [Expected: 80; Actual: 115]
docs/CODE_OF_CONDUCT.md:97:81 MD013/line-length Line length [Expected: 80; Actual: 92]
docs/CODE_OF_CONDUCT.md:103:81 MD013/line-length Line length [Expected: 80; Actual: 116]
docs/CODE_OF_CONDUCT.md:104:81 MD013/line-length Line length [Expected: 80; Actual: 107]
docs/CODE_OF_CONDUCT.md:106:81 MD013/line-length Line length [Expected: 80; Actual: 156]
docs/CODE_OF_CONDUCT.md:107:81 MD013/line-length Line length [Expected: 80; Actual: 423]
docs/CODE_OF_CONDUCT.md:111:81 MD013/line-length Line length [Expected: 80; Actual: 89]
docs/CODE_OF_CONDUCT.md:113:81 MD013/line-length Line length [Expected: 80; Actual: 141]
docs/CODE_OF_CONDUCT.md:115:81 MD013/line-length Line length [Expected: 80; Actual: 129]
docs/CODE_OF_CONDUCT.md:123:81 MD013/line-length Line length [Expected: 80; Actual: 102]
docs/CODE_OF_CONDUCT.md:128:81 MD013/line-length Line length [Expected: 80; Actual: 106]
docs/CODE_OF_CONDUCT.md:129:81 MD013/line-length Line length [Expected: 80; Actual: 120]
docs/CODE_OF_CONDUCT.md:131:81 MD013/line-length Line length [Expected: 80; Actual: 97]
docs/CODE_OF_CONDUCT.md:132:81 MD013/line-length Line length [Expected: 80; Actual: 132]
docs/CODE_OF_CONDUCT.md:134:81 MD013/line-length Line length [Expected: 80; Actual: 133]
docs/CODE_OF_CONDUCT.md:135:81 MD013/line-length Line length [Expected: 80; Actual: 87]
docs/CODE_OF_CONDUCT.md:138:81 MD013/line-length Line length [Expected: 80; Actual: 136]
docs/CODE_OF_CONDUCT.md:146:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:147:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:149:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:150:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:151:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:152:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:153:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:154:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:163:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:164:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:165:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:170:81 MD013/line-length Line length [Expected: 80; Actual: 130]
docs/CODE_OF_CONDUCT.md:172:81 MD013/line-length Line length [Expected: 80; Actual: 145]
docs/CODE_OF_CONDUCT.md:175:81 MD013/line-length Line length [Expected: 80; Actual: 106]
docs/CODE_OF_CONDUCT.md:178:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:179:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:180:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:185:81 MD013/line-length Line length [Expected: 80; Actual: 154]
docs/CODE_OF_CONDUCT.md:189:81 MD013/line-length Line length [Expected: 80; Actual: 101]
docs/CODE_OF_CONDUCT.md:190:81 MD013/line-length Line length [Expected: 80; Actual: 128]
docs/CODE_OF_CONDUCT.md:195:81 MD013/line-length Line length [Expected: 80; Actual: 130]
docs/CODE_OF_CONDUCT.md:200:81 MD013/line-length Line length [Expected: 80; Actual: 138]
docs/CODE_OF_CONDUCT.md:201:81 MD013/line-length Line length [Expected: 80; Actual: 257]
docs/CODE_OF_CONDUCT.md:205:81 MD013/line-length Line length [Expected: 80; Actual: 149]
docs/CODE_OF_CONDUCT.md:206:81 MD013/line-length Line length [Expected: 80; Actual: 124]
docs/CODE_OF_CONDUCT.md:211:81 MD013/line-length Line length [Expected: 80; Actual: 226]
docs/CODE_OF_CONDUCT.md:214:81 MD013/line-length Line length [Expected: 80; Actual: 152]
docs/CODE_OF_CONDUCT.md:217:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/CODE_OF_CONDUCT.md:218:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:220:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:224:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/CODE_OF_CONDUCT.md:225:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:227:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:232:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/CODE_OF_CONDUCT.md:233:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:235:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:236:81 MD013/line-length Line length [Expected: 80; Actual: 190]
docs/CODE_OF_CONDUCT.md:238:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/CODE_OF_CONDUCT.md:239:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/CODE_OF_CONDUCT.md:241:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
README.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 229]
README.md:17:81 MD013/line-length Line length [Expected: 80; Actual: 108]
README.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 271]
README.md:27:81 MD013/line-length Line length [Expected: 80; Actual: 150]
README.md:28:81 MD013/line-length Line length [Expected: 80; Actual: 145]
README.md:29:81 MD013/line-length Line length [Expected: 80; Actual: 163]
README.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 161]
README.md:46:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ git clone https://github.com..."]
README.md:47:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ cd beman"]
README.md:48:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ cmake -S . -B build"]
README.md:49:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ cmake --build build"]
README.md:50:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ ctest --test-dir build"]
README.md:61:81 MD013/line-length Line length [Expected: 80; Actual: 158]
README.md:62:81 MD013/line-length Line length [Expected: 80; Actual: 136]
README.md:63:81 MD013/line-length Line length [Expected: 80; Actual: 168]
README.md:68:81 MD013/line-length Line length [Expected: 80; Actual: 124]
README.md:96:81 MD013/line-length Line length [Expected: 80; Actual: 150]
README.md:102:81 MD013/line-length Line length [Expected: 80; Actual: 106]
README.md:103:81 MD013/line-length Line length [Expected: 80; Actual: 104]
README.md:110:81 MD013/line-length Line length [Expected: 80; Actual: 172]
docs/FAQ.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 203]
docs/FAQ.md:12:81 MD013/line-length Line length [Expected: 80; Actual: 104]
docs/FAQ.md:16:81 MD013/line-length Line length [Expected: 80; Actual: 155]
docs/FAQ.md:18:81 MD013/line-length Line length [Expected: 80; Actual: 136]
docs/FAQ.md:19:81 MD013/line-length Line length [Expected: 80; Actual: 105]
docs/FAQ.md:23:81 MD013/line-length Line length [Expected: 80; Actual: 106]
docs/FAQ.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 119]
docs/FAQ.md:28:81 MD013/line-length Line length [Expected: 80; Actual: 136]
docs/FAQ.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 197]
docs/FAQ.md:33:81 MD013/line-length Line length [Expected: 80; Actual: 121]
docs/FAQ.md:34:81 MD013/line-length Line length [Expected: 80; Actual: 136]
docs/FAQ.md:39:81 MD013/line-length Line length [Expected: 80; Actual: 373]
docs/FAQ.md:46:81 MD013/line-length Line length [Expected: 80; Actual: 137]
docs/GOVERNANCE.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 132]
docs/GOVERNANCE.md:8:81 MD013/line-length Line length [Expected: 80; Actual: 107]
docs/GOVERNANCE.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 96]
docs/GOVERNANCE.md:15:27 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:17:81 MD013/line-length Line length [Expected: 80; Actual: 161]
docs/GOVERNANCE.md:21:46 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:23:81 MD013/line-length Line length [Expected: 80; Actual: 113]
docs/GOVERNANCE.md:27:27 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:29:81 MD013/line-length Line length [Expected: 80; Actual: 102]
docs/GOVERNANCE.md:30:81 MD013/line-length Line length [Expected: 80; Actual: 100]
docs/GOVERNANCE.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 143]
docs/GOVERNANCE.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 129]
docs/GOVERNANCE.md:38:81 MD013/line-length Line length [Expected: 80; Actual: 118]
docs/GOVERNANCE.md:39:81 MD013/line-length Line length [Expected: 80; Actual: 113]
docs/GOVERNANCE.md:41:34 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 109]
docs/GOVERNANCE.md:47:81 MD013/line-length Line length [Expected: 80; Actual: 184]
docs/GOVERNANCE.md:49:37 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:51:81 MD013/line-length Line length [Expected: 80; Actual: 141]
docs/GOVERNANCE.md:53:60 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:55:81 MD013/line-length Line length [Expected: 80; Actual: 134]
docs/GOVERNANCE.md:56:81 MD013/line-length Line length [Expected: 80; Actual: 129]
docs/GOVERNANCE.md:58:81 MD013/line-length Line length [Expected: 80; Actual: 115]
docs/GOVERNANCE.md:62:32 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:64:81 MD013/line-length Line length [Expected: 80; Actual: 111]
docs/GOVERNANCE.md:72:26 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
docs/GOVERNANCE.md:74:81 MD013/line-length Line length [Expected: 80; Actual: 113]
docs/GOVERNANCE.md:78:26 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']

This is run with this following minimal markdown lint config in #62 adapted from exemplar:

# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md033.md
# Disable inline html linter is needed for <details> <summary>
MD033: false
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
# General Column Limit for code is 119.
MD013:
code_block_line_length: 119

@neatudarius
Copy link
Member

@wusatosi @RaduNichita , please sort out the usage of this PR or drop it soon. I think it's OK to add such manual fixes in this repo before #62 is merged. It will take a time to land #62!

@RaduNichita
Copy link
Contributor Author

I agree with @neatudarius.

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.

Update Beman docs style
4 participants