Elaborate Error Message for rpcInternal
High Level Overview of Change
Validator operators are often flummoxed by the below error:
It would be helpful if the error message can instruct the users to run the rippled server in another process (./rippled) before executing any of the command-line client commands.
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)
- [x] Documentation update
- [ ] Chore (no impact to binary, e.g.
.gitignore, formatting, dropping support for older tooling) - [ ] Release
This is an elaboration of an error message.
API Impact
- [ ] Public API: New feature (new methods and/or new fields)
- [ ] Public API: Breaking change (in general, breaking changes should only impact the next api_version)
- [ ]
libxrplchange (any change that may affectlibxrplor dependents oflibxrpl) - [ ] Peer protocol change (must be backward compatible or bump the peer protocol version) No change to API. No impact on performance either.
I manually verified (on MacOS) that the new error message is displayed, if rippled server isn't running in the background.
Needs to be reformatted.
Codecov Report
Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
Project coverage is 76.2%. Comparing base (
1fbf8da) to head (2c011d4). Report is 2 commits behind head on develop.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| src/xrpld/net/detail/RPCCall.cpp | 0.0% | 1 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## develop #4959 +/- ##
=========================================
- Coverage 76.2% 76.2% -0.0%
=========================================
Files 760 760
Lines 61568 61568
Branches 8126 8126
=========================================
- Hits 46909 46899 -10
- Misses 14659 14669 +10
| Files with missing lines | Coverage Δ | |
|---|---|---|
| src/xrpld/net/detail/RPCCall.cpp | 93.8% <0.0%> (ø) |