Skip to content

Commit d6813cd

Browse files
authored
DOC: Fix mismatch in bug-fix release criteria count (#45)
* DOC: Fix mismatch in bug-fix release criteria count Fix mismatch in bug-fix release criteria count. * DOC: Highlight `inputnode` and `outputnode` in bug-fix release criteria Highlight `inputnode` and `outputnode` in bug-fix release criteria section for improved readability/easier identification of code-related terms.
1 parent 84bf5d8 commit d6813cd

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: docs/devs/releases.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ These releases must satisfy four conditions:
1818

1919
1. **Resolving one or more bugs.** These mostly include failures of *fMRIPrep* to complete or producing invalid derivatives (e.g., a NIfTI file of all zeroes).
2020
1. **Derivatives compatibility.** If a subject may be successfully run on 20.0.n, then the imaging derivatives should be identical if rerun with 20.0.(n+1), modulo rounding errors and the effects of nondeterministic algorithms. The changes between successful runs of 20.0.n and 20.0.(n+1) should not be larger than the changes between two successful runs of 20.0.n. Cosmetic changes to reports are acceptable, while differing fields of view or data types in a NIfTI file would not be.
21-
1. **API compatibility.** Workflow-generating functions, workflow input- and outputnode fields must not change. As an end-user application, this may seem overly strict, but the odds of introducing a bug are much higher in these cases.
21+
1. **API compatibility.** Workflow-generating functions, workflow `inputnode` and `outputnode` fields must not change. As an end-user application, this may seem overly strict, but the odds of introducing a bug are much higher in these cases.
2222
1. **User interface compatibility.** Substantial changes to *fMRIPrep* command line must not happen (e.g., the addition of a new, relevant flag).
2323

24-
Note that not all bugs can be fixed in a way that satisfies all three of these criteria without significant effort. A developer may determine that the bug will be fixed in the next feature release.
24+
Note that not all bugs can be fixed in a way that satisfies all four of these criteria without significant effort. A developer may determine that the bug will be fixed in the next feature release.
2525

2626
Additional acceptable changes within a minor release series:
2727

0 commit comments

Comments
 (0)