Improve description of the filename parameter of loadwallet RPC #30269

issue murchandamus openend this issue on June 11, 2024
  1. murchandamus commented at 5:09 pm on June 11, 2024: contributor

    Motivation

    As the documentation for the loadwallet RPC describes, the syntax is:

    loadwallet "filename" ( load_on_startup )
    

    And it further specifies:

    Arguments:
    1. filename (string, required) The wallet directory or .dat file.
    …
    

    What’s not clearly specified in the documentation is that you are to provide the filename relative to the wallet directory ~/.bitcoin/regtest/wallets. It would be great if the documentation were improved in that regard.

    Possible solution

    • Improve the documentation for loadwallet to specify that the filename should be provided as the relative path from the wallet directory.
    • Add an example where a wallet is loaded from a different directory

    Useful Skills

    • git fundamentals

    Guidance for new contributors

    Want to work on this issue?

    For guidance on contributing, please read CONTRIBUTING.md before opening your pull request.

  2. murchandamus added the label good first issue on Jun 11, 2024
  3. MukulKolpe commented at 5:26 pm on June 11, 2024: none
    Hey @murchandamus, can I work on this issue?
  4. willcl-ark commented at 6:22 pm on June 11, 2024: member

    @MukulKolpe absolutely. We don’t generally assign issues in this project. Anyone is free to open a PR fixing any issue.

    As @murchandamus advised in OP, please take care to:

    … read CONTRIBUTING.md before opening your pull request.

    If you have any questions about the issue at hand here, or generally opening a Pull Request in this repo, feel free to ask away in here :)

  5. willcl-ark added the label Docs on Jun 11, 2024
  6. murchandamus commented at 7:20 pm on June 11, 2024: contributor
    Sure! For context, the following Bitcoin Stack Exchange topic was what inspired me to open the issue: https://bitcoin.stackexchange.com/q/123331/5406
  7. bitcoin deleted a comment on Jun 12, 2024
  8. bitcoin deleted a comment on Jun 12, 2024
  9. bitcoin deleted a comment on Jun 12, 2024
  10. am-sq commented at 7:36 pm on June 19, 2024: none
    Wanted to explicitly mention I have opened #30302 to resolve this issue. Thanks in advance for guidance and review.
  11. chennleyi commented at 2:21 am on July 5, 2024: none
    Hi @murchandamus, is this issue about to get resolved? can I work on this issue? I am new to this.
  12. paulmaleauxney commented at 1:02 am on September 23, 2024: none
    @murchandamus if this is still open I can work in it. Please let me know.

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-09-29 01:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me