Skip to content

Commit 865f403

Browse files
luispedroclaude
andcommitted
DOC Reframe backwards-compat page as language changes
Retitle to 'List of language changes' and clarify that 1.6 supports exactly one language version. Drop the outdated note that declaring "1.5" still works with a deprecation warning. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 38e6420 commit 865f403

1 file changed

Lines changed: 15 additions & 17 deletions

File tree

docs/sources/backwards.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1-
# List of backwards compatibility fixes
1+
# List of language changes
22

3-
As NGLess uses a version declaration string at the top of script means that
4-
NGLess can change its behaviour depending on the version used in the script.
3+
Every NGLess script declares a language version on its first line. This page
4+
documents the changes in behaviour introduced by each version so that you can
5+
understand what a script written for an older version expected.
56

6-
This page documents the fixes that are currently implemented.
7+
Note that, in 1.6.0, NGLess supports exactly one language version, `1.6`. Older
8+
versions are documented here for reference, but scripts must be updated to
9+
declare `ngless "1.6"` to run.
710

811
## NGLess 1.6
912

1013
- NGLess is now based on a [Rust implementation](rust.html) (previous versions
11-
were written in Haskell). Version 1.6 is a best-effort exact mirror of 1.5:
12-
update your version declaration from `ngless "1.5"` to `ngless "1.6"`.
13-
Declaring `1.5` still works but prints a deprecation warning; versions older
14-
than 1.5 are no longer supported by the Rust build.
14+
were written in Haskell). Update your version declaration to `ngless "1.6"`;
15+
earlier versions are no longer supported.
1516

1617
## NGLess 1.4
1718

@@ -20,21 +21,19 @@ This page documents the fixes that are currently implemented.
2021
supported any more. Upgrade to the new [external motus
2122
module](https://github.com/ngless-toolkit/ngless-contrib/tree/master/motus.ngm)
2223
if possible.
23-
- Starting in NGLess 1.4, `write()` returns the filename used. Before this,
24-
it returned nothing.
24+
- `write()` returns the filename used. Before this, it returned nothing.
2525

2626
## NGLess 1.1
2727

2828
- The way that CIGAR sequence lengths are computed has changed to match
2929
samtools. This implies that the computation of `min_match_size` and
3030
`min_identity_pc` have slightly changed.
31-
- Starting in NGLess 1.1, `countfile` reorders its input if necessary.
31+
- `countfile` reorders its input if necessary.
3232
- The `count` function now accepts multiple lines of comments at the top of its
33-
`functional_map` arguments
34-
- Starting in NGLess 1.1, `count()` uses the `sense` argument for
35-
strand-specific data. Older scripts may use the deprecated boolean `strand`
36-
argument, where `strand=True` maps to `sense={sense}` and `strand=False` maps
37-
to `sense={both}`.
33+
`functional_map` arguments.
34+
- `count()` uses the `sense` argument for strand-specific data. Older scripts
35+
may use the deprecated boolean `strand` argument, where `strand=True` maps to
36+
`sense={sense}` and `strand=False` maps to `sense={both}`.
3837
- Older Haskell releases of the `mocat` module exposed `coord_file_to_gtf()` to
3938
convert MOCAT `.coord` files to GTF. This helper is not part of the current
4039
Rust standard module surface.
@@ -63,4 +62,3 @@ is automatically treated as:
6362
input = preprocess(input) using |r|:
6463
...
6564
```
66-

0 commit comments

Comments
 (0)