Skip to content

Commit 82df887

Browse files
committed
Automatic formatting changes by markdownlint
1 parent 64d8e3c commit 82df887

File tree

4 files changed

+17
-18
lines changed

4 files changed

+17
-18
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<!-- markdownlint-disable MD024 (no-duplicate-header) -->
2-
<!-- markdownlint-configure-file { "emphasis-style": { "style": "asterisk" } } -->
32

43
# Changelog 🧾
54

β€ŽDEVELOPMENT.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ git push origin $RELEASE_TAG
3131
```
3232

3333
**IMPORTANT 2**: in case a **pre-releaes** was created, the last commit needs to
34-
be discarded as the _release-script_ places a wrong version / snapshot
34+
be discarded as the *release-script* places a wrong version / snapshot
3535
combination in the `pom.xml`:
3636

3737
```bash
@@ -43,7 +43,7 @@ git reset --hard HEAD~1
4343
Building and deploying the package can be greatly simplified using "tasks" in
4444
[Visual Studio Code][www_vscode]. By adding the following settings to the
4545
`.vscode/tasks.json` file, you can simply press `Ctrl+Shift+B` in VS Code and
46-
select the _deploy_ task for running Maven and have the resulting JAR file being
46+
select the *deploy* task for running Maven and have the resulting JAR file being
4747
placed in `/opt/fiji-packaging/Fiji.app/jars/` (adjust to your path as
4848
necessary):
4949

@@ -80,7 +80,7 @@ necessary):
8080
## Linting Python 2.7 with VS Code
8181

8282
For being able to lint the old Python code properly, you'll need to set up an
83-
appropriate _virtualenv_ with `pylint` being installed.
83+
appropriate *virtualenv* with `pylint` being installed.
8484

8585
Using [`fish`][www_fish] and [virtualfish][www_vf], this can be done as follows:
8686

β€ŽTESTING.mdβ€Ž

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ be tested via [`pytest`][pytest] up to a certain level, some (most?) of them
77
should even work in a Python 3 environment.
88

99
To perform those tests, the packges otherwise provided by ImageJ need to be
10-
mocked using the `imcf-fiji-mocks` package. For seting up a _venv_ use the steps
10+
mocked using the `imcf-fiji-mocks` package. For seting up a *venv* use the steps
1111
described here:
1212

1313
```bash
@@ -37,7 +37,7 @@ pip install --upgrade \
3737
pip install -e .
3838
```
3939

40-
Using this _venv_, tests can be triggered just the usual way. To run only
40+
Using this *venv*, tests can be triggered just the usual way. To run only
4141
specific tests, use e.g.
4242

4343
```bash
@@ -48,12 +48,12 @@ pytest tests/bdv/test_processingoptions.py
4848

4949
For running [`pytest`][pytest] in a C-Python 2 environment, things are slightly
5050
more complicated than the approach described for Python 3 above as `pip` for
51-
Python 2 cannot install a project in _editable_ mode unless it has a `setup.py`
51+
Python 2 cannot install a project in *editable* mode unless it has a `setup.py`
5252
file (which we don't have and don't want).
5353

5454
Therefore, a wheel needs to be built (e.g. using [`poetry`][poetry]) and
5555
installed (every time) into the corresponding virtualenv when performing the
56-
tests. Assuming you're having a working _poetry_ setup on your machine, you can
56+
tests. Assuming you're having a working *poetry* setup on your machine, you can
5757
simply use the provided `scripts/py2-pytest.sh` wrapper that will create the
5858
virtualenv, build and install the `imcflibs` wheel and launch `pytest` with the
5959
parameters specified, e.g.
@@ -68,35 +68,35 @@ Unfortunately there is nothing like `pytest` available for the parts that are
6868
running exclusively in a ImageJ2 / Fiji context. So in order to provide at least
6969
some basic, semi-interactive tests the following conventions are being used:
7070

71-
* Each _**function**_ in any of the `imcflibs.imagej` submodules should have its
71+
* Each ***function*** in any of the `imcflibs.imagej` submodules should have its
7272
own directory underneath `/tests/interactive-imagej/`, using their fully
7373
qualified name as the path (only skipping the `imcflibs.` prefix). For example
7474
test scripts for `imcflibs.imagej.bioformats.import_image()` will be placed in
7575
the directory `/tests/interactive-imagej/bioformats/import_image/`.
7676
* The scripts inside those directories are intended to be run interactively /
7777
manually in a (freshly started) Fiji instance. Yes, really. Any other
7878
suggestions are highly welcome!
79-
* To facilitate this, a collection of _test images_ (and possibly other input
79+
* To facilitate this, a collection of *test images* (and possibly other input
8080
data) should be cloned to the local file system. Currently this `sample-data`
81-
repository is _NOT_ publicly available due to legal βš– uncertainties. A repo
81+
repository is *NOT* publicly available due to legal βš– uncertainties. A repo
8282
containing test data πŸ—ž that can be published should be assembled over time
8383
though!
84-
* Any _interactive_ test script should start with a header similar to the one
85-
described below. Paths to input data _inside_ the test scripts **has** to be
84+
* Any *interactive* test script should start with a header similar to the one
85+
described below. Paths to input data *inside* the test scripts **has** to be
8686
relative to the location of the `sample-data` repository mentioned above. This
8787
will allow for a fairly okayish testing workflow like this:
8888
* Make your changes in VS Code, then trigger a build by pressing `Shift` +
89-
`Ctrl` + `B`. If things are configured as described in the _DEVELOPMENT_
89+
`Ctrl` + `B`. If things are configured as described in the *DEVELOPMENT*
9090
document, the resulting `.jar` file will be automatically placed in Fiji's
9191
`jars/` folder.
9292
* Next, start a fresh instance of the Fiji that received the newly built JAR.
9393
* After Fiji has started, simply drag and drop the desired test script onto
94-
the main window. This will open the _Script Editor_, then press `Ctrl` + `R`
94+
the main window. This will open the *Script Editor*, then press `Ctrl` + `R`
9595
to launch the script.
9696
* Only on the first run on the machine being used you will have to select the
9797
base location of the `sample-data` repository.
98-
* All subsequent runs of _**any**_ test script using the defined _Script
99-
Parameter_ `IMCF_TESTDATA` will remember this selection, so it will be
98+
* All subsequent runs of ***any*** test script using the defined *Script
99+
Parameter* `IMCF_TESTDATA` will remember this selection, so it will be
100100
sufficient to just confirm the dialog by pressing `Enter`.
101101

102102
### Quick Workflow Summary

β€Žpoetry.lock.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)