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

TODO notes in generated code are inconsistent #665

Closed
mrlacey opened this issue Jul 7, 2017 · 4 comments
Closed

TODO notes in generated code are inconsistent #665

mrlacey opened this issue Jul 7, 2017 · 4 comments
Assignees
Labels
Generated Code Relates specifically to code contained in the generated project. question Indicates that the issue is an open question on how future functionality should work.
Milestone

Comments

@mrlacey
Copy link
Collaborator

mrlacey commented Jul 7, 2017

In the generated code a number of comments are included that start "TODO UWPTemplates: " but only

For example:

// TODO UWPTemplates: For more information regarding the application lifecycle and how to handle suspend and resume, please see:
// Documentation: https://docs.microsoft.com/windows/uwp/launch-resume/app-lifecycle

and

// TODO UWPTemplates: This event is fired just before the app enters in background. Subscribe to this event if you want to save your current state.

Here there is nothing the developer must do. These actions are optional. Should we really be saying these are things that every developer should do in every app?

We should review all such TODO comments and remove the "TODO" part from the ones that are optional or just provide information.
We should only include the "TODO" part for non-optional changes that the developer must make to the generated code.

@mrlacey mrlacey added Generated Code Relates specifically to code contained in the generated project. question Indicates that the issue is an open question on how future functionality should work. labels Jul 7, 2017
@mrlacey mrlacey added this to the Backlog milestone Jul 7, 2017
@crutkas
Copy link
Member

crutkas commented Jul 7, 2017

Yeah, also why we have it as "UWPTemplates" is legacy as well.

How about:
// TODO WTS: [action required]
// NOTE WTS: [optional but helpful]

@ralarcon ralarcon self-assigned this Jul 10, 2017
@ralarcon
Copy link
Contributor

Changed all "//TODO UWPTemplates:" by "// TODO WTS:"; Not added "// NOTE WTS:" where the comment is just an extension or clarification as it adds too much verbosity.

ralarcon added a commit that referenced this issue Jul 12, 2017
@ralarcon ralarcon added Can Close Out Soon Work relating to this issue has been completed. and removed Can Close Out Soon Work relating to this issue has been completed. labels Jul 12, 2017
@crutkas
Copy link
Member

crutkas commented Jul 12, 2017

Reviewed @ralarcon, good first step and i'll approve. this will be something we need to look at each one for 1.3

@mrlacey
Copy link
Collaborator Author

mrlacey commented Jul 18, 2017

can close out now? It's in dev branch

@crutkas crutkas closed this as completed Jul 19, 2017
@ghost ghost locked as resolved and limited conversation to collaborators Jun 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Generated Code Relates specifically to code contained in the generated project. question Indicates that the issue is an open question on how future functionality should work.
Projects
None yet
Development

No branches or pull requests

3 participants