diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index e0075ab4b..4e8a3c4e7 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -4689,38 +4689,24 @@ The following standard intervals can be enabled with command-line flags: More complex intervals can be specified using `-p/--period`, described below. -## Date adjustment +## Start date adjustment -When there is a report interval (other than daily), report start/end dates -which have been inferred, eg from the journal, are automatically adjusted to -natural period boundaries. This is convenient for producing simple periodic reports. -More precisely: +When there is a report interval (other than daily), a "soft" report start date - +ie one which was not specified explicitly, but inferred, perhaps from the journal - +will be adjusted earlier if needed to start on a natural period boundary. -- an inferred start date will be adjusted earlier if needed to fall on a - natural period boundary +A "hard" report date - one specified explicitly, eg by `-b` - will not be adjusted +(since hledger 1.29). +This makes it possible to start subperiods on any date. +Note if you specify a start date, it's ideal to set it to a period boundary +(eg a monday for weekly reports, a first day of month for monthly reports..), +as this will generate simple period headings; otherwise they will be more verbose. -- an inferred end date will be adjusted later if needed to make the last period - the same length as the others. +## End date adjustment -By contrast, start/end dates which have been specified explicitly, -with `-b`, `-e`, `-p` or `date:`, will not be adjusted (since hledger 1.29). -This makes it possible to specify non-standard report periods, but it also means -that if you are specifying a start date, you should pick one that's on a period boundary -if you want to see simple report period headings. - - +The report end date (even if specified explicitly) will be adjusted later +as needed to enclose a whole number of report intervals. +Eg in a `--yearly` report, all subperiods will be one year long. ## Period expressions