Fix SpecialPowers.pushPrefEnv comment

RESOLVED FIXED in mozilla18

Status

Testing
Mochitest
RESOLVED FIXED
6 years ago
6 years ago

People

(Reporter: Justin Lebar (not reading bugmail), Assigned: Justin Lebar (not reading bugmail))

Tracking

unspecified
mozilla18
Points:
---
Bug Flags:
in-testsuite -

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Assignee)

Description

6 years ago
This has been confusing me for some time.  Now that I understand what's actually going on (the prefs get restored automatically after the test!), I've fixed up the comment.

Patch in a moment.
(Assignee)

Comment 1

6 years ago
Created attachment 664688 [details] [diff] [review]
Patch, v1
Attachment #664688 - Flags: review?(ted.mielczarek)
(Assignee)

Updated

6 years ago
Assignee: nobody → justin.lebar+bug
Comment on attachment 664688 [details] [diff] [review]
Patch, v1

Review of attachment 664688 [details] [diff] [review]:
-----------------------------------------------------------------

::: testing/specialpowers/content/specialpowersAPI.js
@@ +456,4 @@
>     *
> +   * |inPrefs| must be an object with up to two properties, "set" and "clear".
> +   * We will set prefs as indicated in |inPrefs.set|, and we will unset the
> +   * prefs indicated in |inPrefs.clear|.

The "we"s in these comments read a little awkwardly, FWIW.
Attachment #664688 - Flags: review?(ted.mielczarek) → review+
(Assignee)

Comment 3

6 years ago
I pushed with tweaked wording:

https://hg.mozilla.org/integration/mozilla-inbound/rev/02f0c3cf5575

I removed the "we"s and made the example more prominent (since I think it's easier to understand an example than it is to parse a grammar, like I had it before).
https://hg.mozilla.org/mozilla-central/rev/02f0c3cf5575
Status: NEW → RESOLVED
Last Resolved: 6 years ago
Flags: in-testsuite-
Resolution: --- → FIXED
Target Milestone: --- → mozilla18
You need to log in before you can comment on or make changes to this bug.