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

doc: Added entry for run command option profile-create-new-if-missing #832

Conversation

akhilpanchal
Copy link
Contributor

@rpl
Doc entry for web-ext run command option --profile-create-new-if-missing. Follow up to web-ext pull request.

Please let me know if I have missed something.

@akhilpanchal
Copy link
Contributor Author

Hi @rpl:
Looks like this feature is released in 5.4.0 but is not documented
Can you review these doc changes?

Copy link
Member

@rpl rpl left a comment

Choose a reason for hiding this comment

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

@akhilpanchal apologies for letting you wait that much on this PR, I have been away for a week and just got back.

The description of the new option is technically right, I just suggested some small tweaks to make it a bit more consistent with the description of the --keep-profile-changes option.
Let me know what do you think about the tweaks I did suggest in the inline comment below.

@caitmuenster would you mind to also review this from an editorial perspective after I've marked it as approved?

Comment on lines 250 to 253
This option is to be used with `--firefox-profile` or `--chromium-profile`. With this option, the profile option provided will be treated as a directory path and if the directory does not exist, it will be created.

Environment variable: `$WEB_EXT_PROFILE_CREATE_IF_MISSING`

Copy link
Member

Choose a reason for hiding this comment

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

Nit, how about tweaking this description a bit to make it consistent with the --keep-profile-changes option that follows? e.g. something like:

With this option, the profile directory (specified by the `--firefox-profile` or `--chromium-profile` options) will be created if it does not exist yet. 

::: note alert
When this option is specified the `--firefox-profile` option is always treated as a directory path.
:::

Environment variable: `$WEB_EXT_PROFILE_CREATE_IF_MISSING`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Definitely! This is more concise and clear.

@caitmuenster
Copy link
Contributor

Thanks so much for the patch, @akhilpanchal! This looks good from an editorial perspective.

Copy link
Member

@rpl rpl left a comment

Choose a reason for hiding this comment

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

@akhilpanchal Thanks a lot for following up the web-ext pull request by also updating the docs! ❤️

last_updated_by: noraj
date: 2020-10-11 18:11:47
last_updated_by: akhilpanchal
date: 2020-11-15 12:46:15
Copy link
Member

Choose a reason for hiding this comment

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

Nit, we may update the date before merging (not strictly mandatory to be fair)

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm -- I'll go ahead and update it to reflect the next deploy date of Dec 03.

@caitmuenster caitmuenster merged commit aece697 into mozilla:master Nov 30, 2020
@caitmuenster
Copy link
Contributor

Hey @akhilpanchal, I wanted to follow up with you but unfortunately couldn't find your contact information. :( I would love to send you some stickers as a small token of appreciation for your recent contributions! Would you mind sending me an email at cneiman [at] mozilla [dot] com with your current mailing address?

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.

None yet

3 participants