Skip to content

Commit 92b4876

Browse files
committed
[doc] Update: rename odmlconversion
The documentation in docs, README and CHANGELOG has been updated with the rename of the CLI script 'odmlconversion' to 'odmlconvert'.
1 parent ad4d411 commit 92b4876

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ of this stylesheet will be downloaded from `templates.g-node.org` to
3232
the current directory when starting up the service.
3333
```
3434

35+
## Console script 'odmlconversion' is renamed
36+
The console script `odmlconversion` is renamed to `odmlconvert`. For backwards compatibility the script will be available as `odmlconversion` with a deprecation notice.
37+
3538
## 'pyyaml' dependency update
3639
The `pyyaml` dependency has been changed to the non-breaking beta version 4.2b4. See issue #291 for details.
3740

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ pip install odml
4242

4343
The Python installation features multiple convenience commandline scripts.
4444

45-
- `odmlconversion`: Converts odML files of previous file versions into the current one.
45+
- `odmlconvert`: Converts odML files of previous file versions into the current one.
4646
- `odmltordf`: Converts odML files to the supported RDF version of odML.
4747
- `odmlview`: Render and browse local XML odML files in the webbrowser.
4848

4949
All scripts provide detailed usage descriptions by adding the `help` flag to the command.
5050

51-
odmlconversion -h
51+
odmlconvert -h
5252
odmltordf -h
5353
odmlview -h
5454

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ pip install odml
7777

7878
The Python installation features multiple convenience commandline scripts.
7979

80-
- `odmlconversion`: Converts odML files of previous file versions into the current one.
80+
- `odmlconvert`: Converts odML files of previous file versions into the current one.
8181
- `odmltordf`: Converts odML files to the supported RDF version of odML.
8282
- `odmlview`: Render and browse local XML odML files in the webbrowser.
8383

8484
All scripts provide detailed usage descriptions by adding the `help` flag to the command.
8585

86-
odmlconversion -h
86+
odmlconvert -h
8787
odmltordf -h
8888
odmlview -h
8989

0 commit comments

Comments
 (0)