slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: changelogs cleanup

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-01-31 15:43:08 -08:00
parent afd7cae169
commit 9955f53b9b
6 changed files with 50 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CHANGES.md
View File

@ -1,16 +1,41 @@
General/project-related changes in the hledger project.
For package-specific changes, see the package changelogs.
# a37c18e5
# afd7cae1
- install: fix "stack" installation when .local/bin is not in PATH (Dmitry Astapov)
- package: added helper scripts in docker/ (Dmitry Astapov)
- cli: command help: reduce width, line wrapping
cmdargs wraps any lines longer than 78 characters. To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
- shake: Shake PKG (or Shake build) builds packages plus their docs
"stack build hledger" will not notice changes in documentation source
files (like hledger/Hledger/Cli/Commands/Add.md or
hledger-lib/hledger_journal.m4.md), but "./Shake hledger" will.
"./Shake build" builds all the packages, like a doc-aware "stack build".
- make: ghci-shake
- package: added Dockerfile (Dmitry Astapov)
- site: download: link adept's & other docker images
- site: download: link sandstorm
- site: download: platform headings
- site: download: fix the TOC links
- site: home: link download page
I accidentally the link.
- make: include Shake.hs in tags
- shake: manuals: also depend on new command doc files
# 0a31ef84
# 9bc88727
- fixed pandoc typography conversion in web manuals (#954).
Eg `--` was being rendered as en-dash.

6
hledger-api/CHANGES.md
View File

@ -1,11 +1,7 @@
User-visible changes in hledger-api.
See also the hledger changelog.
# 17cd5b22
# 0a31ef84
# 1e5e30ae
# 9fe32129
- use hledger 1.12.99

10
hledger-lib/CHANGES.md
View File

@ -1,19 +1,15 @@
Internal/api/developer-ish changes in the hledger-lib package.
For user-visible changes, see the hledger package changelog.
# 2df8a6c4
- lib: refactor, add embedFileRelative
# 0a31ef84
# 1e5e30ae
# 9fe32129
added:
- setFullPrecision
- setMinimalPrecision
- expectParseStateOn
- embedFileRelative
- hereFileRelative
changed:

6
hledger-ui/CHANGES.md
View File

@ -1,11 +1,7 @@
User-visible changes in hledger-ui.
See also the hledger changelog.
# 2df8a6c4
# 0a31ef84
# 1e5e30ae
# 9fe32129
- on posix systems, control-z suspends the program

6
hledger-web/CHANGES.md
View File

@ -1,11 +1,7 @@
User-visible changes in hledger-web.
See also the hledger changelog.
# 17cd5b22
# 0a31ef84
# 1e5e30ae
# 9fe32129
- use hledger 1.12.99

23
hledger/CHANGES.md
View File

@ -1,22 +1,23 @@
User-visible changes in the hledger command line tool and library.
# 469b7153
# 5435150d
- cli: commands list: update command descriptions
- cli: command help: reduce width, line wrapping
cmdargs wraps any lines longer than 78 characters. To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
- cli: commands list: show addons prefixed with +
- cli: render command help as plain text, hiding markup
This means committing a bunch more generated files, but it's probably
worthwhile, so we can have both rich hyperlinked/styled command docs
and clean readable command help.
- cli: commands list: update, reorganise, show addons prefixed with +
- doc: integrate CLI help & manual for remaining commands
& rename HelpTemplate -> CommandDoc
- lib: refactor, add embedFileRelative
- hereFileRelativeToPackage -> hereFileRelative
# 0a31ef84
# 1e5e30ae
- renamed HelpTemplate -> CommandDoc
- journal: account directive: account sort codes like `account 1000`
are no longer supported. (introduced in 1.9, deprecated in 1.11)