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

Cleanup API-CHANGELOG.md #5207

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Bronek
Copy link
Collaborator

@Bronek Bronek commented Dec 2, 2024

High Level Overview of Change

Some of the PRs merged before the 2.3.0 release have mangled the API-CHANGELOG.md (e.g. #5096 ) . Lets clean this up.

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Performance (increase or change in throughput and/or latency)
  • Tests (you added tests for code that already exists, or your new feature included in this PR)
  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)
  • Release

Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.9%. Comparing base (f64cf91) to head (6ea52b4).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           develop   #5207     +/-   ##
=========================================
- Coverage     77.9%   77.9%   -0.0%     
=========================================
  Files          784     784             
  Lines        66681   66680      -1     
  Branches      8162    8157      -5     
=========================================
- Hits         51950   51922     -28     
- Misses       14731   14758     +27     

see 8 files with indirect coverage changes

Impacted file tree graph


### Breaking change in 2.3
### Breaking changes in 2.3.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Breaking changes in 2.3.0
### Breaking changes

2.3.0 is already specified in the header, I don't think it needs to be specified here as well

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We double-specified it so that the anchor links are unique and thus linkable. Example: https://github.com/XRPLF/rippled/blob/develop/API-CHANGELOG.md#breaking-changes-in-111

If it's just Breaking changes then the anchor link becomes ambiguous


- `book_changes`: If the requested ledger version is not available on this node, a `ledgerNotFound` error is returned and the node does not attempt to acquire the ledger from the p2p network (as with other non-admin RPCs).

Admins can still attempt to retrieve old ledgers with the `ledger_request` RPC.

### Addition in 2.3
### Additions and bugfixes in 2.3.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Additions and bugfixes in 2.3.0
### Additions and bugfixes

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

Successfully merging this pull request may close these issues.

3 participants