When creating fields together with a signature, the CLI currently does not always do the "obvious" thing. In particular, certain combinations of parameters that don't really make sense are still processed with sometimes counterintuitive results. This PR adds error handling and more informative failure messages for such cases. It also adds a point of clarification to the documentation regarding the --field argument to addsig in the CLI usage guide.
See #272 for the question that prompted this change. (CC: @regonzalom)
Checklist
Please go over this checklist to increase the chances of your PR being worked on in a timely manner. Deviations are allowed with proper justification (see previous section).
[x] I have read the project's CoC and contribution guidelines.
[x] All new code in this PR has full test coverage.
For new features (delete if not applicable)
[x] I have discussed the implementation of this feature with the project maintainer(s) on the discussion forum or over email.
[x] I have verified that my changes do not break existing API or CLI functionality, or ensured that all breaking changes are clearly documented in this PR.
[x] All public API functionality in this PR is documented.
For documentation contributions (delete if not applicable)
[x] I have built the HTML documentation locally, and verified that the changes behave correctly in-browser.
Description of the changes
When creating fields together with a signature, the CLI currently does not always do the "obvious" thing. In particular, certain combinations of parameters that don't really make sense are still processed with sometimes counterintuitive results. This PR adds error handling and more informative failure messages for such cases. It also adds a point of clarification to the documentation regarding the
--fieldargument toaddsigin the CLI usage guide.See #272 for the question that prompted this change. (CC: @regonzalom)
Checklist
Please go over this checklist to increase the chances of your PR being worked on in a timely manner. Deviations are allowed with proper justification (see previous section).
For new features (delete if not applicable)
For documentation contributions (delete if not applicable)