From 056a917b2ac3d5358bb3b9bd308367957cbdc5ec Mon Sep 17 00:00:00 2001 From: billc Date: Thu, 29 Feb 2024 15:10:10 -0800 Subject: [PATCH 1/3] fix --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97be136..e33a11f 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ -# demo \ No newline at end of file +# Demo + +This is a demonstration repository for the Hyperlint product. For more information, you should read [the documentation(https://docs.hyperlint.com/). + +This chnge only exists to be able to show off what a review looks like and what kind of information you should expect back from a review. + + +## Vale failure ExAmPlE + +The above should trigger a vale failure, let's see! \ No newline at end of file From bd4ce102030e4bc7b1664bf4fbc60847d64ddb5b Mon Sep 17 00:00:00 2001 From: billc Date: Tue, 5 Mar 2024 09:07:34 -0800 Subject: [PATCH 2/3] add getting started guide --- getting-started-with-python.md | 42 ++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 getting-started-with-python.md diff --git a/getting-started-with-python.md b/getting-started-with-python.md new file mode 100644 index 0000000..4efed5e --- /dev/null +++ b/getting-started-with-python.md @@ -0,0 +1,42 @@ +--- +title: Some Front Matter +--- + +# Some Big Title + +## Some Subtitle + +### Step 2: Write Your First Python Program + +Open a new file in your text editor, and write the following code: + +```python +print("Hello, World!") +``` + +Save the file as `hello.py`. Now you can run that file all by yourself because you're a big boy! + +### Step 4: Write a Basic Function + +Let's write a function that adds two numbers. Add the following code to your `hello.py` file: + +```python +def add_numbers(num1, num2): + return num1 + num2 + +print(add_numbers(3, 5)) +``` + +## This is renaming + +This is another section that contains text. This is something else. This is a change that I am proposing. Here's a change again. + +This is an addition, while this is a change. This section needs to be written. + +### Step 5: Run Your Updated Python Program + +Run the `hello.py` file again with the command `python hello.py`. You should see the result of the addition printed to the console. + +## Conclusion + +In conclusion, you've learned more about python and are now ready to do more things with python because you learned. \ No newline at end of file From 4014a6c43097fcd1c625880ddc5be846a062d4ea Mon Sep 17 00:00:00 2001 From: billc Date: Tue, 5 Mar 2024 09:08:21 -0800 Subject: [PATCH 3/3] fix spelling errors --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index e33a11f..cfd58d5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,5 @@ # Demo -This is a demonstration repository for the Hyperlint product. For more information, you should read [the documentation(https://docs.hyperlint.com/). +This is a demonstration repository for the Hyperlint product. For more information, you should read [the documentation](https://docs.hyperlint.com/). This chnge only exists to be able to show off what a review looks like and what kind of information you should expect back from a review. - - -## Vale failure ExAmPlE - -The above should trigger a vale failure, let's see! \ No newline at end of file