Skip to content

Decide whether we want to support third-party library snippets #371

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

Closed
brettcannon opened this issue Dec 7, 2017 · 4 comments
Closed

Decide whether we want to support third-party library snippets #371

brettcannon opened this issue Dec 7, 2017 · 4 comments
Labels
debt Covers everything internal: CI, testing, refactoring of the codebase, etc.

Comments

@brettcannon
Copy link
Member

#370 brings up the point as to where we draw the line for having snippets for third-party libraries (especially for ones that the extension isn't explicitly set up to support). E.g. should we drop the ipdb snippet and stick to only stuff that works with the stdlib or if we specifically support it somehow in the extension (e.g. some flake8 snippet)?

@brettcannon brettcannon added awaiting 1-decision debt Covers everything internal: CI, testing, refactoring of the codebase, etc. labels Dec 7, 2017
@jeffwidman
Copy link

jeffwidman commented Dec 7, 2017

I see valid arguments either way, from a user perspective having some sort of "batteries included" extension that I can add that includes snippets for many common python tools/libs would be useful. Whether that lives here or in an additional "third-party python tools" extension I really don't care.

From a "marketing" standpoint, having some of these commonly used tool snippets makes for a better out of the box experience for VS Code n00bs... I actually contributed the pudb statement because back when I first started using Atom I was surprised and delighted they included the snippet included by default. I wasn't expecting it in there, so it became one of those UI touches that makes you say "they got all the details right". Now that I've switched to VSCode, I wasn't surprised that it was missing, but it left me feeling like it was a missed opportunity to delight users.

As I'm sure you're aware, the problem is that this path leads to subjective judgement calls on which tools are "popular enough" to include.

You also might think about splitting the python snippets file into two... one for basic python, and one for python-common-third-party-extensions. I would enable them both, it just makes maintenance easier if it's split into two files.

@brettcannon
Copy link
Member Author

@qubitron @Microsoft/pvsc-team any thoughts on this so we don't leave @jeffwidman hanging too long with his PR?

I'll start off by saying I'm willing to accept PRs for snippets and such involving popular projects, but it's up to our subjective choice as to what is "popular" and we obviously reserve the right to yank support as deemed necessary (e.g. popularity drops, support becomes painful, etc.).

@brettcannon
Copy link
Member Author

After discussing things over with @qubitron , we decided we will accept snippets for third-party projects and just use our own common-sense on when we think the usefulness of a snippet is simply too marginal to warrant the overhead of having the snippet name show up in the UI.

@jeffwidman
Copy link

That sounds reasonable to me. I'd also continue to work hard to make sure the 3p snippets are in separate code from the stdlib snippets... just makes life easier.

@lock lock bot locked as resolved and limited conversation to collaborators Jul 12, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
debt Covers everything internal: CI, testing, refactoring of the codebase, etc.
Projects
None yet
Development

No branches or pull requests

2 participants