Add documentation for version-string #30
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
malept
requested changes
May 9, 2017
| 'LegalCopyright': 'Copyright (C) Acme Inc.', | ||
| 'ProductName': 'My Test' | ||
| } | ||
|
|
|
|
||
| ``` | ||
| var options = { | ||
|
|
| `version-string` allows you to set the PE file meta keys, such as in the following example: | ||
|
|
||
| ``` | ||
| var options = { |
There was a problem hiding this comment.
This block should probably go in an "options example" section (I'm not entirely sure what the section should be titled though), since it's showing more than just an example of version-string.
| @@ -37,6 +37,25 @@ On platforms other than Windows, you will need to have [Wine](http://winehq.org) | |||
| * `application-manifest` - String path to a local manifest file to use. | |||
| See [here](https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191.aspx) | |||
| for more details. | |||
|
|
|||
| `version-string` allows you to set the PE file meta keys, such as in the following example: | |||
There was a problem hiding this comment.
This should have a link to the MSDN docs, like application-manifest does.
malept
changed the title
kevinsawicki
reviewed
May 9, 2017
|
|
||
| `version-string` allows you to set the PE file meta keys, such as in the following example: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Might want to make this js so it highlights.
```js
|
Closing stale PRs. This PR has not addressed the last code review from over a year ago. Please reopen or resubmit this PR after addressing the reviewer's comments. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
node-rcedit was also suffering the lack of documentation for
version-stringmentioned on electron/rcedit#2This PR adds to the README examples of usage of the object, as seen on unindented/grunt-rcedit
By the way, unindented/grunt-rcedit#1 has added a table to the README that lists every possible key and explains what it means. However it doesn't fit to me to tell whether this repo must bring that information or if users should find that information on official sources (i.e.: MSDN).