Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upDocs: Remove TODO comments from examples regarding removal of bang symbol #31132
Comments
This comment has been minimized.
This comment has been minimized.
I want to colaborate. |
This comment has been minimized.
This comment has been minimized.
Hey @jbogarthyde^^ Thanks, @AXEL1988! |
This comment has been minimized.
This comment has been minimized.
That's great -- We just need to remove the comments, it looks like the code doesn't need to change at all. The only tricky part is finding them all - there seem to be a lot of them!
We've only noticed it in the API examples, I don't know if it occurs in the guide examples. |
This comment has been minimized.
This comment has been minimized.
Hi all, |
This comment has been minimized.
This comment has been minimized.
Hi @Menuka5! That'd be great! I can help you with the process if you like. :) |
This comment has been minimized.
This comment has been minimized.
@kapunahelewong Yes, please |
This comment has been minimized.
This comment has been minimized.
@Menuka5 I think the only comments to remove are:
Take a look at #24571 to see a screenshot. The tricky part is finding all of them. I believe though, that they are only in the API docs, not the guide documentation. I think you want to leave the docregions because without them things will break. @petebacondarwin can you confirm that I'm giving @Menuka5 the right direction? |
This comment has been minimized.
This comment has been minimized.
I found over 100+ entries lines contains above line in the project. |
This comment has been minimized.
This comment has been minimized.
Do NOT remove any ‘docregion’ or ‘enddocregion’ comments. Remove ONLY the ‘TODO’ comments. |
This comment has been minimized.
This comment has been minimized.
Got it. Will send a pull request after around 1 hour. |
This comment has been minimized.
This comment has been minimized.
I opened a pull request. Hopefully, I didn't violate your PR rules |
This comment has been minimized.
This comment has been minimized.
I left a comment on the PR. |
This comment has been minimized.
This comment has been minimized.
@brandonroberts @kapunahelewong @jbogarthyde Can please answer the concern of @petebacondarwin In PR #31713 |
This comment has been minimized.
This comment has been minimized.
@Menuka5, we'll need to follow @petebacondarwin's guidance here. As far as how to refactor to fix the underlying code (that is, to do the "TODO"), we'd need engineering input unless you know how to refactor the code to fix it. The place I can help you most effectively is the process of getting the PR through review, git questions, pinging the right experts, etc. Please let me know your thoughts. |
This comment has been minimized.
This comment has been minimized.
I don't understand the new requirement. I am a beginner to angular. |
This comment has been minimized.
This comment has been minimized.
@Menuka5 - I don't know if this is a beginner's task. We need to work out on a case-by-case basis how to remove the Some are fairly easy, such as this https://github.com/angular/angular/pull/31713/files#r305699323, where we simply provide an initializer. - public easing !: string | null;
+ public easing: string | null = null; But in each case you must think through the necessary change. |
This comment has been minimized.
This comment has been minimized.
I agree that deciding whether the I recommend closing the existing PR and starting over. Look only in the examples directories, and remove only those
To reduce the review burden (since the examples touch so many different areas, which need to be reviewed by different code-owners), it might be best to do a separate PR for each |
Related to #24571. After talking with @IgorMinar, its acceptable for these to be in the codebase, but they don't need to be displayed in examples shown on the docs site. Rather than adding docregions to hide them, we are going to remove the TODO comments from the package examples.
The examples are in the
packages/examples
folder.One example: https://github.com/angular/angular/blob/master/packages/examples/core/di/ts/provider_spec.ts#L58