File: 3.5.0.markdown

package info (click to toggle)
scopt 3.5.0%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 312 kB
  • sloc: xml: 45; makefile: 13
file content (39 lines) | stat: -rw-r--r-- 1,156 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  [@Jibbers42]: https://github.com/Jibbers42
  [109]: https://github.com/scopt/scopt/pull/109

## breaking changes

### two-column rendering

scopt 3.5.0 introduces two-column rendering for the usage text, which is enabled by default:

    scopt 3.x
    Usage: scopt [update] [options] [<file>...]

      -f, --foo <value>        foo is an integer property
      -o, --out <file>         out is a required file property

    Command: update [options]
    update is a command.
      --xyz <value>            xyz is a boolean property

This is a bit more compact compared to the previous (one-column) rendering that looked like this:

    scopt 3.x
    Usage: scopt [update] [options] [<file>...]

      -f <value> | --foo <value>
            foo is an integer property
      -o <file> | --out <file>
            out is a required file property

    Command: update [options]
    update is a command.
      --xyz <value>
            xyz is a boolean property

You can switch back to the one-column rendering as follows:

    override def renderingMode = scopt.RenderingMode.OneColumn

This feature was contributed by [@Jibbers42][@Jibbers42] as [#109][109].