Skip to content

Commit

Permalink
style
Browse files Browse the repository at this point in the history
  • Loading branch information
Konubinix committed Feb 8, 2024
1 parent 23ec64b commit 192b9fa
Show file tree
Hide file tree
Showing 17 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion clk/overloads.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
2 changes: 1 addition & 1 deletion doc/lp/README.md
Original file line number Diff line number Diff line change
@@ -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.
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.
2 changes: 1 addition & 1 deletion doc/lp/lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ def rm(*file_or_tree):
shutil.rmtree(f)
else:
os.unlink(f)
```
```
6 changes: 3 additions & 3 deletions doc/use_cases/bash_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -78,4 +78,4 @@ EOF
clk mycommand
```

something
something
2 changes: 1 addition & 1 deletion doc/use_cases/bash_command_built_in_lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Then run this command.
```bash
cat file_with_duplicate.txt | clk mycommand
```
```
2 changes: 1 addition & 1 deletion doc/use_cases/bash_command_from_alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
2 changes: 1 addition & 1 deletion doc/use_cases/bash_command_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ EOH

```bash
test "$(clk somecommand)" = "SOMETHING"
```
```
2 changes: 1 addition & 1 deletion doc/use_cases/bash_command_use_option.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
```
2 changes: 1 addition & 1 deletion doc/use_cases/dealing_with_secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,4 +256,4 @@ clk --keyring clk.keyrings.NetrcKeyring secret show http_bearer --secret

## Footnotes

<sup><a id="fn.1" class="footnum" href="#fnr.1">1</a></sup> this is so that if you use `clk` in scripts, you will be aware that something went wrong
<sup><a id="fn.1" class="footnum" href="#fnr.1">1</a></sup> this is so that if you use `clk` in scripts, you will be aware that something went wrong
2 changes: 1 addition & 1 deletion doc/use_cases/dynamic_parameters_advanced_use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ clk openapi post somepath d
```

PUT on somepath with a
POST on somepath with d
POST on somepath with d
6 changes: 3 additions & 3 deletions doc/use_cases/ethereum_local_environment_dev_tool.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -329,9 +329,9 @@ test.

<<create-project>>

check-result(alias-with-project)
check-result(alias-with-project)

check-result(deploy-again)

check-result(run-with-project-abi)
#+END_SRC
2 changes: 1 addition & 1 deletion doc/use_cases/flow_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
The flow is done
2 changes: 1 addition & 1 deletion doc/use_cases/lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
```
```
2 changes: 1 addition & 1 deletion doc/use_cases/rolling_your_own.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ Commands:
secret Manipulate your secrets
trigger Manipulate command triggers
value Manipulate the values
```
```
2 changes: 1 addition & 1 deletion doc/use_cases/using_a_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ echo somecontent > somefile.txt
clk exec cat project:somefile.txt
```

somecontent
somecontent

0 comments on commit 192b9fa

Please sign in to comment.