search

google / differential-privacy

Google's differential privacy libraries.
Apache License 2.0
3.08k stars 353 forks source link

README code fencing is off by one. #122

Closed jpgoldberg closed 2 years ago

jpgoldberg commented 2 years ago

The build instructions in README.md has what should be normal next in code blocks and what should be in code blocks as normal text.

I will assign this to myself and submit a pull request shortly.

jpgoldberg commented 2 years ago

Do I really want to create a fork for a one-line edit in the README? No, I don't.

Here us the diff

diff --git a/README.md b/README.md
index 48a4bd1..ff4de34 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,9 @@ You also need to install Git, if you don't have it already.
 Once you've installed Bazel and Git, open a Terminal and clone the
 differential privacy directory into a local folder:

-```git clone https://github.com/google/differential-privacy.git```
+```
+git clone https://github.com/google/differential-privacy.git
+```

 Navigate into the ```differential-privacy``` folder you just created,
 and build the differential privacy library and dependencies using Bazel
dibakch commented 2 years ago

Thank you for spotting this and filing this issue! I've fixed this directly in our internal version that will be pushed to GitHub soon.