From 192b9fa5b6267eff12017385a46b8a667caf3e26 Mon Sep 17 00:00:00 2001 From: Samuel Loury Date: Thu, 8 Feb 2024 14:32:53 +0100 Subject: [PATCH] style --- README.org | 4 ++-- clk/overloads.py | 2 +- doc/README.md | 2 +- doc/lp/README.md | 2 +- doc/lp/lib.md | 2 +- doc/use_cases/bash_command.md | 6 +++--- doc/use_cases/bash_command_built_in_lib.md | 2 +- doc/use_cases/bash_command_from_alias.md | 2 +- doc/use_cases/bash_command_import.md | 2 +- doc/use_cases/bash_command_use_option.md | 2 +- doc/use_cases/dealing_with_secrets.md | 2 +- doc/use_cases/dynamic_parameters_advanced_use_cases.md | 2 +- doc/use_cases/ethereum_local_environment_dev_tool.org | 6 +++--- doc/use_cases/flow_options.md | 2 +- doc/use_cases/lib.md | 2 +- doc/use_cases/rolling_your_own.md | 2 +- doc/use_cases/using_a_project.md | 2 +- 17 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.org b/README.org index 5c008b5..a1b3f3c 100644 --- a/README.org +++ b/README.org @@ -63,7 +63,7 @@ might write even more [[./doc][documentation]]. #+END_SRC Then create a hello world command with - + #+NAME: cwd #+BEGIN_SRC bash :results none :exports none :session fe60735c-91c2-4f54-8ae2-7e3b307f27a5 cd tests/use_cases/ @@ -106,7 +106,7 @@ might write even more [[./doc][documentation]]. Low level command line tools are very powerful. Yet they are not very intuitive. It takes time to understand those like *find*, *kill*, *tr*, *awk* or *sed*. We spend a lot of time reading the documentation and the tool itself - does not help much[fn:2]. + does not help much[fn:2]. It looks like a lot of high level command line tools, like *maven* or *npm* have followed the same idea of relying on a comprehensive documentation and diff --git a/clk/overloads.py b/clk/overloads.py index 13ad987..b12481b 100644 --- a/clk/overloads.py +++ b/clk/overloads.py @@ -33,7 +33,7 @@ class CommandNotFound(Exception): def __init__(self, cmd_name): - super().__init__(f"Command {cmd_name} not found") + super().__init__(f'Command {cmd_name} not found') self.cmd_name = cmd_name diff --git a/doc/README.md b/doc/README.md index 79a9793..ccb1d8b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,4 +2,4 @@ This is the main entry point of the documentation. For now, only the [use cases](./use_cases) are worth reading. They show several real life situations that highlight how **clk** may be used. -I started to write some code literate programming, so you can find the generated documentation in [here](./lp), but it is still quite useless on its current state. \ No newline at end of file +I started to write some code literate programming, so you can find the generated documentation in [here](./lp), but it is still quite useless on its current state. diff --git a/doc/lp/README.md b/doc/lp/README.md index bbdde83..6c74f93 100644 --- a/doc/lp/README.md +++ b/doc/lp/README.md @@ -1,3 +1,3 @@ This is where the generated documentation of the code written in literate programming. -For now, only a few function are documented in [here](./lib). It is more an experiment with literate programming than a useful documentation. But who knows, it may grow to eventually become something interesting. \ No newline at end of file +For now, only a few function are documented in [here](./lib). It is more an experiment with literate programming than a useful documentation. But who knows, it may grow to eventually become something interesting. diff --git a/doc/lp/lib.md b/doc/lp/lib.md index 2bbd074..c5cfe0f 100644 --- a/doc/lp/lib.md +++ b/doc/lp/lib.md @@ -24,4 +24,4 @@ def rm(*file_or_tree): shutil.rmtree(f) else: os.unlink(f) -``` \ No newline at end of file +``` diff --git a/doc/use_cases/bash_command.md b/doc/use_cases/bash_command.md index b2dc165..3332fd6 100644 --- a/doc/use_cases/bash_command.md +++ b/doc/use_cases/bash_command.md @@ -57,9 +57,9 @@ clk mycommand --help ``` Usage: clk mycommand [OPTIONS] - + Command that says something - + Options: --help-all Show the full help message, automatic options included. --help Show this message and exit. @@ -78,4 +78,4 @@ EOF clk mycommand ``` - something \ No newline at end of file + something diff --git a/doc/use_cases/bash_command_built_in_lib.md b/doc/use_cases/bash_command_built_in_lib.md index 37126ff..c5e6737 100644 --- a/doc/use_cases/bash_command_built_in_lib.md +++ b/doc/use_cases/bash_command_built_in_lib.md @@ -51,4 +51,4 @@ Then run this command. ```bash cat file_with_duplicate.txt | clk mycommand -``` \ No newline at end of file +``` diff --git a/doc/use_cases/bash_command_from_alias.md b/doc/use_cases/bash_command_from_alias.md index 52c3659..46763d8 100644 --- a/doc/use_cases/bash_command_from_alias.md +++ b/doc/use_cases/bash_command_from_alias.md @@ -67,4 +67,4 @@ clk music play MyAlbum Running mpc with: start-server Running mpc with: play --random --use-speakers --replaygain --repeat MyAlbum -Now, we fan change its content to do whatever we want, like waiting for the music server to be ready, trying to switch on the speakers and falling back to some other ones etc. \ No newline at end of file +Now, we fan change its content to do whatever we want, like waiting for the music server to be ready, trying to switch on the speakers and falling back to some other ones etc. diff --git a/doc/use_cases/bash_command_import.md b/doc/use_cases/bash_command_import.md index 9b86e65..36d56b8 100644 --- a/doc/use_cases/bash_command_import.md +++ b/doc/use_cases/bash_command_import.md @@ -51,4 +51,4 @@ EOH ```bash test "$(clk somecommand)" = "SOMETHING" -``` \ No newline at end of file +``` diff --git a/doc/use_cases/bash_command_use_option.md b/doc/use_cases/bash_command_use_option.md index c3214b5..93e8f47 100644 --- a/doc/use_cases/bash_command_use_option.md +++ b/doc/use_cases/bash_command_use_option.md @@ -79,4 +79,4 @@ clk animal 2>&1 > /dev/null | grep "Missing argument 'KIND_OF_ANIMAL'" ```bash test "$(clk animal duck --sound-of-animal couac)" = "duck does couac" test "$(clk animal whale --shout)" = "I DON'T KNOW WHAT SOUND WHALE MAKES" -``` \ No newline at end of file +``` diff --git a/doc/use_cases/dealing_with_secrets.md b/doc/use_cases/dealing_with_secrets.md index 1489900..c72090e 100644 --- a/doc/use_cases/dealing_with_secrets.md +++ b/doc/use_cases/dealing_with_secrets.md @@ -256,4 +256,4 @@ clk --keyring clk.keyrings.NetrcKeyring secret show http_bearer --secret ## Footnotes -1 this is so that if you use `clk` in scripts, you will be aware that something went wrong \ No newline at end of file +1 this is so that if you use `clk` in scripts, you will be aware that something went wrong diff --git a/doc/use_cases/dynamic_parameters_advanced_use_cases.md b/doc/use_cases/dynamic_parameters_advanced_use_cases.md index d04784d..875c5cb 100644 --- a/doc/use_cases/dynamic_parameters_advanced_use_cases.md +++ b/doc/use_cases/dynamic_parameters_advanced_use_cases.md @@ -74,4 +74,4 @@ clk openapi post somepath d ``` PUT on somepath with a - POST on somepath with d \ No newline at end of file + POST on somepath with d diff --git a/doc/use_cases/ethereum_local_environment_dev_tool.org b/doc/use_cases/ethereum_local_environment_dev_tool.org index 5a2ac5e..5284dde 100644 --- a/doc/use_cases/ethereum_local_environment_dev_tool.org +++ b/doc/use_cases/ethereum_local_environment_dev_tool.org @@ -118,7 +118,7 @@ address. Let's try it #+NAME: try_deploy -#+BEGIN_SRC bash :results verbatim :exports both :session cd599835-d6ac-4970-8f7f-34d82068ef4b :cache yes +#+BEGIN_SRC bash :results verbatim :exports both :session cd599835-d6ac-4970-8f7f-34d82068ef4b :cache yes clk eth deploy clk eth deploy #+END_SRC @@ -329,9 +329,9 @@ test. <> - check-result(alias-with-project) + check-result(alias-with-project) check-result(deploy-again) - + check-result(run-with-project-abi) #+END_SRC diff --git a/doc/use_cases/flow_options.md b/doc/use_cases/flow_options.md index 66d5883..4a9318b 100644 --- a/doc/use_cases/flow_options.md +++ b/doc/use_cases/flow_options.md @@ -87,4 +87,4 @@ clk printer flow myprinter --model somemodel --model someothermodel --warn-when- Slicing somemodel, someothermodel to model.gcode Printing model.gcode using myprinter Driiiiiiing! - The flow is done \ No newline at end of file + The flow is done diff --git a/doc/use_cases/lib.md b/doc/use_cases/lib.md index 564da9e..6abf558 100644 --- a/doc/use_cases/lib.md +++ b/doc/use_cases/lib.md @@ -39,4 +39,4 @@ download('https://github.com/clk-project/clk/raw/main/tests/zipfile.zip', assert f.exists() z = zipfile.ZipFile(f) assert z.read('readme').decode() == 'hello from some zip file\n' -``` \ No newline at end of file +``` diff --git a/doc/use_cases/rolling_your_own.md b/doc/use_cases/rolling_your_own.md index f20b3f7..49fa59c 100644 --- a/doc/use_cases/rolling_your_own.md +++ b/doc/use_cases/rolling_your_own.md @@ -112,4 +112,4 @@ Commands: secret Manipulate your secrets trigger Manipulate command triggers value Manipulate the values -``` \ No newline at end of file +``` diff --git a/doc/use_cases/using_a_project.md b/doc/use_cases/using_a_project.md index 0693326..da3c4f8 100644 --- a/doc/use_cases/using_a_project.md +++ b/doc/use_cases/using_a_project.md @@ -73,4 +73,4 @@ echo somecontent > somefile.txt clk exec cat project:somefile.txt ``` - somecontent \ No newline at end of file + somecontent