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

ux: wallet: update delete usage #8442

Merged
merged 3 commits into from
Apr 13, 2022
Merged

ux: wallet: update delete usage #8442

merged 3 commits into from
Apr 13, 2022

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Apr 6, 2022

Renaming the cmd to soft-delete to better reflect what it does - and specify that a hard deletion is needed for permanent removal.

Should address #6926 to a degree, becuase it tells the user that extra steps are needed at least.

Checklist

Before you mark the PR ready for review, please make sure that:

  • All commits have a clear commit message.
  • The PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, INTERFACE BREAKING CHANGE, CONSENSUS BREAKING, build, chore, ci, docs,perf, refactor, revert, style, test
    • area: api, chain, state, vm, data transfer, market, mempool, message, block production, multisig, networking, paychan, proving, sealing, wallet, deps
  • This PR has tests for new functionality or change in behaviour
  • If new user-facing features are introduced, clear usage guidelines and / or documentation updates should be included in https://lotus.filecoin.io or Discussion Tutorials.
  • CI is green

Renaming the function to soft-delete to better reflect what it does - and specify that a hard deletion is needed for permanent removal.
@rjan90 rjan90 requested a review from a team as a code owner April 6, 2022 08:25
Change from `delete` to `soft-delete` in the TestWalleteDelete test.
Copy link
Contributor

@Kubuxu Kubuxu left a comment

Choose a reason for hiding this comment

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

We cannot just rename an existing command, it will break existing scripts.

We could proceed with the rename but we should add an alias to delete and maybe a deprecation notice. @jennijuju what do you think?

@jennijuju
Copy link
Member

Yes, thanks for the callout!

I would say maybe we can just keep it simple - update the usage and keep the name?> @Kubuxu any preference?

@Kubuxu
Copy link
Contributor

Kubuxu commented Apr 8, 2022

any preference

no really, can really go either way for me

@arajasek
Copy link
Contributor

Updating the usage is sufficient imo.

Revert `soft-delete` cmd back to `delete`. Keeps the updated usage
@codecov
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #8442 (c3f2f12) into master (caeeb6a) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #8442      +/-   ##
==========================================
- Coverage   40.26%   40.19%   -0.08%     
==========================================
  Files         683      683              
  Lines       74480    74480              
==========================================
- Hits        29989    29936      -53     
- Misses      39263    39303      +40     
- Partials     5228     5241      +13     
Impacted Files Coverage Δ
cli/wallet.go 41.97% <ø> (ø)
chain/events/observer.go 71.64% <0.00%> (-6.72%) ⬇️
extern/storage-sealing/currentdealinfo.go 71.17% <0.00%> (-5.41%) ⬇️
chain/sub/incoming.go 45.25% <0.00%> (-2.45%) ⬇️
miner/miner.go 57.70% <0.00%> (-2.30%) ⬇️
chain/exchange/client.go 52.96% <0.00%> (-1.70%) ⬇️
chain/events/events_called.go 83.90% <0.00%> (-1.47%) ⬇️
chain/stmgr/searchwait.go 67.30% <0.00%> (-1.29%) ⬇️
chain/gen/gen.go 68.19% <0.00%> (-1.23%) ⬇️
chain/vm/vm.go 61.63% <0.00%> (-1.07%) ⬇️
... and 11 more

@rjan90 rjan90 changed the title ux: wallet: soft-delete wallet ux: wallet: update delete usage Apr 12, 2022
@magik6k magik6k merged commit 84470e9 into filecoin-project:master Apr 13, 2022
@momack2
Copy link
Contributor

momack2 commented Apr 19, 2022

Is there any instruction we can give folks on HOW to hard delete the file? Seems like an important next step we should make accessible but very clear to avoid mistakes! Is there a “hard-delete” command we could add?

@rjan90 rjan90 deleted the ux/soft-delete-wallet branch April 20, 2022 12:20
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.

6 participants