Update comments written by component_writers.h #1043
Merged
Conversation
This file contains hidden or 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
Clarified how to correctly manage generated files in the comment.
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ChrisGuzak
approved these changes
Oct 20, 2021
oldnewthing
reviewed
Oct 21, 2021
oldnewthing
reviewed
Oct 21, 2021
cppwinrt/component_writers.h
Outdated
| // add this file to your project, as any changes you make will be lost. | ||
| // | ||
| // If this is a new file: | ||
| // 1. Copy this file from the 'Generated Files' directory into the |
Member
There was a problem hiding this comment.
Note that the name "Generated Files" did not come from cppwinrt.exe. It came from the Visual Studio <GeneratedFilesDir> property in Directory.Build.props. Somebody who uses a different build system (like Razzle) will have an output directory that isn't named "Generated Files".
Perhaps
Suggested change
| // 1. Copy this file from the 'Generated Files' directory into the | |
| // 1. Copy this file from its current location into the |
Contributor
Author
There was a problem hiding this comment.
Interesting. The problem is that "current location" is relative, so if you've already moved / copied the file and then "forget" you already did it, the "current location" is actually the proper location. I'll change it to "original location" (which is still not super helpful, but...).
Accept Raymond's suggestion Co-authored-by: Raymond Chen <oldnewthing@users.noreply.github.com>
Accept Raymond's suggestion Co-authored-by: Raymond Chen <oldnewthing@users.noreply.github.com>
Accept Raymond's suggestion Co-authored-by: Raymond Chen <oldnewthing@users.noreply.github.com>
Accept Raymond's suggestion Co-authored-by: Raymond Chen <oldnewthing@users.noreply.github.com>
Accept Raymond's suggestion Co-authored-by: Raymond Chen <oldnewthing@users.noreply.github.com>
More cleanup based on Raymond's feedback.
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
kennykerr
approved these changes
Oct 25, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Clarified how developers should manage generated files. Addresses #1042