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

Documentation is not inline with the current command palette #3

Open
hilsonp opened this issue Feb 7, 2024 · 1 comment
Open

Documentation is not inline with the current command palette #3

hilsonp opened this issue Feb 7, 2024 · 1 comment

Comments

@hilsonp
Copy link

hilsonp commented Feb 7, 2024

Today, I tried to re-use the Screwdriver plugin.
I remember it is pretty useful.

The problem is that since we are touching to the settings we want to make sure we use the right commands.

Therefore, I went back to the documentation which says that I should "Dump files" and the use the "Restore".

The current palette command are:

  • "Dump or fetch files" : Can you update the documentation What does the "fetch" mean ???
  • "Restore files"

The command palette options may be easier to understand like this:

  • "Add target directory" (why not creating a configuration panel to set this up and manage it later ? This would be neat !)
  • "Create dump template" : Ok clear enough.
  • "Dump or fetch files" : This is unclear. Suggestion : "Save settings to the active file" or "Save settings into the active file using settings written in this file"
  • "Restore files" : This is unclear. Suggestion: "Restore settings based on the current file content"

Hope this helps and makes this more clear for other users.

@vrtmrz
Copy link
Owner

vrtmrz commented Feb 25, 2024

Thank you for opening the issue! And sorry for missing this!

As you mentioned, these commands have been so ambiguous.
Also mentioned, there was no description of why the Add target directory is a separate command.

So, Thanks to your advice, I refined the command name.

  • Create dump template is now separated into two commands.
    • Create or add local file exporting template: This can make a template to export the local files.
    • Create or add remote file fetching template: This can make a template to fetch the file from the internet.
  • Dump or fetch files is completely renamed. : Export specified files and store into the active file
  • And the Restore files is also changed: Restore exported files from the active file

I hope that this improvements make the situation clear. Would you mind If I ask you to check the latest version, please?

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

No branches or pull requests

2 participants