Open francescobianco opened 7 months ago
None
)[!TIP] I can email you when I complete this pull request if you set up your email here!
I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.
README.md
✓ https://github.com/javanile/pipetest/commit/dc1e60b6a48dc1c9353a8134630a67c2b0181e38 Edit
Modify README.md with contents:
• Remove the duplicate sections for `assert_file_exists` that start at lines 166 and 195.
• This will correct the redundancy in the documentation.
--- +++ @@ -161,6 +161,15 @@ + + +```bash +mv old_file_name.txt new_file_name.txt +assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working." +``` + + +
### ➡ | `assert_file_exists` @@ -178,21 +187,13 @@ assert_file_exists sample_file.txt ``` -```bash -mv old_file_name.txt new_file_name.txt -assert_file_exists new_file_name.txt "Moving file goes wrong." -``` - -```bash -mv old_file_name.txt new_file_name.txt -assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working." -``` - - - -
- -### ➡ | `assert_file_exists` + + + + +
+ +### ➡ | `assert_directory_exists` **Usage** @@ -221,35 +222,6 @@
-### ➡ | `assert_directory_exists` - -**Usage** - -```bash -assert_file_exists [FAIL_MESSAGE] [SUCCESS_MESSAGE] -``` - -**Examples** - -```bash -touch sample_file.txt -assert_file_exists sample_file.txt -``` - -```bash -mv old_file_name.txt new_file_name.txt -assert_file_exists new_file_name.txt "Moving file goes wrong." -``` - -```bash -mv old_file_name.txt new_file_name.txt -assert_file_exists new_file_name.txt "Moving file goes wrong." "Ok! it working." -``` - - - -
- ## Contributing See [CONTRIBUTING.md in the repo](https://github.com/javanile/pipetest/blob/main/CONTRIBUTING.md), obviously pull-request are welcome.
README.md
✓ Edit
Check README.md with contents:
Ran GitHub Actions for dc1e60b6a48dc1c9353a8134630a67c2b0181e38:
README.md
▶ Edit
Modify README.md with contents:
• Replace the incorrect command `assert_file_exists` with the correct command `assert_directory_exists` in the usage section and examples.
• Add a description for the `assert_directory_exists` function, similar to the other functions, explaining that it fails if the piped directory name as text does not exist.
• Provide examples for the `assert_directory_exists` function, such as: ```bash mkdir sample_dir assert_directory_exists sample_dir "Directory does not exist." ```
• Add a description and examples for the `assert_directory_not_exists` function, explaining that it fails if the piped directory name as text exists.
• Provide examples for the `assert_directory_not_exists` function, such as: ```bash rmdir sample_dir assert_directory_not_exists sample_dir "Directory still exists." ```
• These changes will fill in the missing descriptions and examples, ensuring the documentation is complete and accurate.
README.md
▶ Edit
Check README.md with contents:
Working on it...
💡 To recreate the pull request edit the issue title or description. Something wrong? Let us know.
This is an automated message generated by Sweep AI.
Please, correct the "Documentation" section on README.md file. Fill in empty examples and missing description
Checklist
- [X] Modify `README.md` ✓ https://github.com/javanile/pipetest/commit/dc1e60b6a48dc1c9353a8134630a67c2b0181e38 [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L137-L220) - [X] Running GitHub Actions for `README.md` ✓ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L137-L220) - [ ] Modify `README.md` ▶ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L224-L250) - [ ] Running GitHub Actions for `README.md` ▶ [Edit](https://github.com/javanile/pipetest/edit/sweep/correct_documentation_section_on_readmem/README.md#L224-L250)