Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs: Remove TODO comments from examples regarding removal of bang symbol

See original GitHub issue

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

Issue Analytics

State:
Created 4 years ago
Comments:19 (10 by maintainers)

Top GitHub Comments

1reaction

jbogarthydecommented, Jul 22, 2019

I agree that deciding whether the ! actually needs to be removed is not a beginners task. The task should be to remove only the TODO comments, and only in doc examples.

I recommend closing the existing PR and starting over. Look only in the examples directories, and remove only those TODO comments that come between // #docregion and // #enddocregion comments.

The imported examples for guide pages are under angular/aio/content/examples/
The ones for the API reference pages are under angular/packages/examples/

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 examples/_package-or-area_ subfolder.

1reaction

MenukaIshancommented, Jul 22, 2019

I don’t understand the new requirement. I am a beginner to angular. Can you elaborate more on how to fix this? An example would be nice.

Top Results From Across the Web

Use comments, action items, & emoji reactions - Google Support

On your computer, open a document, spreadsheet, or presentation. · On the comment you want to edit or delete, click More More ....

TODO comments | PyCharm Documentation - JetBrains

Clear the Treat indented text on the following lines as part of the same TODO checkbox. TODO comments example. View TODO items.

Automating the Removal of Obsolete TODO Comments - arXiv

We built our dataset by collecting TODO comments from the top-10,000 Python and Java Github repositories and evaluated TDCleaner on them.

Configuration :: RuboCop Docs

# rubocop:disable Layout/LineLength --This is a bad comment that includes other than cop name. ruby copy icon Copied! Temporarily enabling cops in source...

eslint-plugin-unicorn/expiring-todo-comments.md at main

TODO (@lubien) [>0]: For now this is fine but for a stable version we must refactor. // FIXME [>10]: This feature is deprecated...