Skip to content
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

Documentation and opt-in autocomplete for other languages #14

Open
chrisjaure opened this issue Oct 11, 2012 · 2 comments
Open

Documentation and opt-in autocomplete for other languages #14

chrisjaure opened this issue Oct 11, 2012 · 2 comments

Comments

@chrisjaure
Copy link

I'm not sure there's much you can do here, but I've set up sub and created a javascript subcommand. To get automatic documentation and opt-in autocomplete, I had to make weird comments like

/*
# Usage: blah
*/

/*
# Provide sn completions
*/

because the comment syntax (#) is hard-coded. I realize this isn't a simple fix, but I thought I'd bring it up anyway.

Ideally, the language's comment syntax would be used so in javascript, I could just write:

/*
Usage: blah
*/

// Provide sub completions
@qrush
Copy link
Owner

qrush commented Oct 11, 2012

Awesome! Yeah, I figured this would come up. We should just handle // as well as #.

@markstos
Copy link
Contributor

markstos commented Jun 2, 2023

I recommend closing this as "not doing". The "weird" syntax for nested JavaScript is not that bad, while making the "sub" project much simpler to not try to understand all the different possible comment formats.

@qrush has a decent middle-ground idea to just support // and # which supports a few popular languages without trying to support them all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants