Skip to content

Commit

Permalink
Fixed internal link across two lines error, updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BenTheKush committed Sep 13, 2023
1 parent 0075f05 commit 56b0852
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ stronger test suites and specifications should detect more mutants as faulty.
You can download prebuilt Gambit binaries for Mac and Linux from our
[releases](https://github.com/Certora/gambit/releases) page.

To build Gambit from source, clone [the Gambit repository](https://github.com/Certora/gambit) and run
To build Gambit from source, clone [the Gambit
repository](https://github.com/Certora/gambit) and run

```
cargo build --release
Expand All @@ -183,9 +184,9 @@ location on your `PATH`.
## Usage

Gambit has two main commands: the [`mutate` command](#the-mutate-command), which
is responsible for generating mutants, and the
[`summary` command](#the-summary-command), which allows the user to get a
high-level summary of a `gambit mutate` execution.
is responsible for generating mutants, and the [`summary`
command](#the-summary-command), which allows the user to get a high-level
summary of a `gambit mutate` execution.


<!-- ANCHOR: (the-mutate-command)= -->
Expand Down Expand Up @@ -514,7 +515,8 @@ Gambit implements the following mutation operators
| **unary-operator-replacement** | Replace a unary operator with another | `-b` -> `~b` |
| **statement-deletion** | Replace a statement with a no-op (`assert(true)`) | `self.checkInvariants();` -> `assert(true);` |

For more details on each mutation type, refer to the [full documentation](https://docs.certora.com/en/latest/docs/gambit/gambit.html#mutation-types).
For more details on each mutation type, refer to the [full
documentation](https://docs.certora.com/en/latest/docs/gambit/gambit.html#mutation-types).

<!-- SUPPRESS -->
## Contact
Expand Down
7 changes: 4 additions & 3 deletions scripts/generate_rtd_markdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,10 @@ def translate_readme_to_rtd(readme_file_path: str) -> str:
)
else:
# replace internal links
l = replace_internal_references(line)
lines2.append(l.strip("\n"))
return "\n".join(lines2) + "\n"
lines2.append(line.strip("\n"))
combined = "\n".join(lines2) + "\n"
combined = replace_internal_references(combined)
return combined


def main():
Expand Down

0 comments on commit 56b0852

Please sign in to comment.