<commit_before>#Conventions 

Please conform to the following conventions when submitting code to sustain readability.

===

##Comments

All comments must come **before** the line that is being talked about. 


    // this function is used to check for something
    void checkSomething(int item);
    
    // this line is used to add two numbers
    int x = 5 + 1;


Multi-line comments must be as follows:

    /* this comment is to demonstrate
     * multi-line commenting conventions
     * for the Jayfor project.
     */

===

##Functions

Functions must be declared as per usual, and the opening brace must come on the same line as the 
function after a single space.

    void test(int x, float y) { // <- the brace must be on the same line, after 1 space
        return (x + y);
    }

===

##If conditionals

If the `if` conditional must execute a single statement, use the braces anyway.

    if(condition) {
        x = 1 + 2;
    } else {
          x = 1 + 3;
      }

Instead of doing this:

    if(condition)
        x = 1 + 2;

This is to maintain consistency.

**This rule applies to all other loops/conditionals, not just for the *if* conditional**.

    for(int x = 1; x < 10; x++) {
        x = x + 1;
    }

and so on...


===
<commit_msg>updated the conventions thign<commit_after>#Conventions 

Please conform to the following conventions when submitting code to sustain readability.

===

## Snake Case
We use snake case

    like_this

## Comments

All comments must come **before** the line that is being talked about. 

    // this function is used to check for something
    void check_something(int item);
    
    // this line is used to add two numbers
    int x = 5 + 1;


Multi-line comments must be as follows:

    /* 
     * this comment is to demonstrate
     * multi-line commenting conventions
     * for the Jayfor project.
     */

## Documentation
Documentation comments with two asteriks, we use
doxygen -- so conform to their system please :)

    /**
     * This is my documentation
     * @param param1 this is doxygen
     */

All documentation should for functions should go in the
header files!

===

##Functions

Functions must be declared as per usual, and the opening brace must come on the same line as the 
function after a single space.

    void test(int x, float y) { // <- the brace must be on the same line, after 1 space
        return x + y;
    }

===

##If conditionals

If the `if` conditional must execute a single statement, use the braces anyway.

    if (condition) {
        x = 1 + 2;
    } 
    else {
        x = 1 + 3;
    }

Instead of doing this:

    if(condition)
        x = 1 + 2;

This is to maintain consistency.

**This rule applies to all other loops/conditionals, not just for the *if* conditional**.

    for (int x = 1; x < 10; x++) {
        x = x + 1;
    }

and so on...


===

{'fraction_non_alphanumeric': 0.08408932309839498, 'fraction_numerical': 0.00942079553384508, 'mean_word_length': 2.4212410501193316, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6844673', 'n_tokens_mistral': 873, 'n_tokens_neox': 803, 'n_words': 391}