You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Whether or not this is adopted, all type comments should be changed from line comments (// ...) to docblock comments (/** ... */). The reason for this is to allow tooling to pick up the types' descriptions when generating docs pages. See atom-community/atom-community.github.io#8
Not a great idea, since atom-ide-datatip is not an npm dependency, and it doesn't need to be (I would argue it shouldn't be). If you move the types to atom-ide-datatip, getting the type definitions would get harder with no apparent benefit. In any case, having a separate API type spec for a public-facing project is a good idea -- I wouldn't recommend relying on tsc-generated definitions, because that could make things very unstable unless everyone involved is very, very careful. So if the only question is where to keep those, I think here is fine.
What you should do in my opinion is install this as a dependency (via devDependenices obviously) in atom-ide-datatip and use the types defined here as interfaces (via extends/ implements) to make sure everything is consistent. That is, if you didn't do that already, which, judging by the question in OP, I assume you didn't.
Now that
atom-ide-datatip
has been converted to TypeScript, perhaps, we could move the types away from here and into theatom-ide-datatip
repository.The text was updated successfully, but these errors were encountered: