Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

;doc: add version annotations for new features #2155

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

hamzashezad
Copy link
Contributor

@hamzashezad hamzashezad commented Jan 13, 2024

This PR aims to document the version a feature was introduced. As discussed in the Matrix room, *Added in <version>* will be prepended to;

  1. heading, or if it doesn't exist
  2. the description.

For v1.32,

Dropped;

- match groups and match negations
- beancount output format
- tsv output format
- consistently add annotation
- `--round` for print
@hamzashezad hamzashezad marked this pull request as ready for review January 16, 2024 22:05
@simonmichael simonmichael merged commit 6afff58 into simonmichael:master Jan 17, 2024
1 check passed
@simonmichael simonmichael added the docs Documentation-related. label Jan 17, 2024
@simonmichael
Copy link
Owner

Thank you!

What do you think should be the policy for maintaining these (how long do we keep them ?)

@hamzashezad
Copy link
Contributor Author

Once a version is considered old enough, it's accompanying annotations can be removed. "Old enough" could be judged by when OS packages have caught up, e.g. nixpkgs, debian, etc. Looking at https://hledger.org/install.html#binary-packages, 1.30 is common, so maybe keep them for a fixed number of versions, say for the next two versions.

Personally, I'd keep unless they need to be removed because why bother.

@simonmichael
Copy link
Owner

@hamzashezad if you have time, maybe add these to the 1.32 manuals in hledger_site repo also, for https://hledger.org/1.32/hledger.html

@simonmichael
Copy link
Owner

simonmichael commented Jan 18, 2024 via email

@hamzashezad
Copy link
Contributor Author

@simonmichael sure, I can add to the hledger_site repo as well. Can you guide me how the files are generated?

"Since" does sound better.

@simonmichael
Copy link
Owner

simonmichael commented Jan 18, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants