GithubHelp home page GithubHelp logo

"TODO(username):" pattern about smart_todo HOT 3 CLOSED

shopify avatar shopify commented on May 24, 2024
"TODO(username):" pattern

from smart_todo.

Comments (3)

Edouard-chin avatar Edouard-chin commented on May 24, 2024 1

👋 Thanks for opening the issue!

It sounds like smart_todo will try to interpret all TODO(*) comments

yeah that's correct it will try to parse all comment that starts with TODO(.
However, if the syntax inside the TODO() is not the one expected, it won't do anything.

Does writing TODO(me) creates a problem? It shouldn't

from smart_todo.

burke avatar burke commented on May 24, 2024

Nope that sounds great then, I just opened this without trying, but it does raise the opposite case... what if the user meant for a todo to be a smart todo but typo’d something? Will it silently not work? Sorry, I’ll just read the code.

from smart_todo.

Edouard-chin avatar Edouard-chin commented on May 24, 2024

meant for a todo to be a smart todo but typo’d something? Will it silently not work?

Yes indeed it will silently fail. Though, if an app uses rubocop and activated the smart_todo_cop, malformated Smart Todo will be reported https://github.com/Shopify/smart_todo/wiki/Restrict-regular-TODO

from smart_todo.

Related Issues (17)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.