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

Add CI to enforce one sentence per CR/LF #1939

Open
markcmiller86 opened this issue Dec 17, 2023 · 2 comments
Open

Add CI to enforce one sentence per CR/LF #1939

markcmiller86 opened this issue Dec 17, 2023 · 2 comments

Comments

@markcmiller86
Copy link
Member

All of our text processing tools (including most of the high quality diffing and auto-merging tools) operate on the quanta of a single line of text (delimited typically by carriage-return/line-feed chars). This is crticial as it effects many aspects of GitHub workflows and GitHub.com features like suggesting changes, how likely two authors working on the same file will create merge conflicts, how easily patch files can be created and applied, etc. Don't take my word for it. See these notes, originally suggested by @bartlettroscoe.

We all write our code according to this rule. When we write code, we do NOT do this...

#include <stdio.h> int main() { printf("Hello, world!\n"); for(int i = 0; i < 5; i++) { printf("%d ", i); } return 0; }

We DO, do this...

#include <stdio.h>

int main() {
    printf("Hello, world!\n");
    for(int i = 0; i < 5; i++) {
        printf("%d ", i);
    }
    return 0;
}

Can we please agree to adding some CI to ensure our prose follows this same basic rule as well?

@bartlettroscoe
Copy link
Member

I wonder how robust such as check would be? I mean, periods, question marks, etc. can appear in the middle of a sentience in some cases (such as 'i.e.', 'e.g.', etc.).

@rinkug
Copy link
Member

rinkug commented Feb 5, 2024

The check would be good.
I forget all the time.
EB docs should have this change too right?

@markcmiller86 : If you have time to delver deeper and do it, then please go ahead (Thanks!). Else put the existing label of "postoned for future"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
BSSw Internal
  
Backlog
Development

No branches or pull requests

3 participants