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

[Feature Request] Add multiline description support in user snippets #66036

Closed
zombie110year opened this issue Jan 4, 2019 · 3 comments · Fixed by #66159
Closed

[Feature Request] Add multiline description support in user snippets #66036

zombie110year opened this issue Jan 4, 2019 · 3 comments · Fixed by #66159
Assignees
Labels
feature-request Request for new features or functionality good first issue Issues identified as good for first-time contributors help wanted Issues identified as good community contribution opportunities snippets

Comments

@zombie110year
Copy link

While creating a user snippet, the rule must be like this:

"example": {
	"prefix": "example",
	"body": [
		"line 1",
		"line 2"
	],
	"description": "A single line description"
}

If I want to show a lot of description, I must write a huge string which includes many escape characters like this:

"toctree": {
	"prefix": ".. toctree::",
	"body": [
		".. toctree::",
		"$0"
	],
	"description": "A toctree item, have these options:\n\t:maxdepth: para\n\t:caption: para
\n\t:numbered:\n\t:titlesonly:\n\t:glob:\n\t:reversed:\n\t:hidden:\n\t:includehidden:",
	"scope": "text.restructuredtext"
},

It maybe a good idea that description option receive a list value, like the body:

"toctree": {
	"prefix": ".. toctree::",
	"body": [
		".. toctree::",
		"$0"
	],
	"description": [
		"A toctree item, have these options:",
		":maxdepth: para",
		":caption: para",
		":numbered:",
		":titlesonly:",
		":glob:",
		":reversed:",
		":hidden:",
		":includehidden:"
	],
	"scope": "text.restructuredtext"
},
@zombie110year zombie110year changed the title [Feature Request] add Multiline description support in user snippets [Feature Request] Add multiline description support in user snippets Jan 4, 2019
@zombie110year
Copy link
Author

The Version infomations:

  • Code Version: 1.30.1 (user setup)
  • Commit: dea8705
  • Date: 2018-12-18T18:12:07.165Z
  • Electron: 2.0.12
  • Chrome: 61.0.3163.100
  • Node.js: 8.9.3
  • V8: 6.1.534.41
  • OS: Windows_NT x64 10.0.17763

@jrieken jrieken added help wanted Issues identified as good community contribution opportunities feature-request Request for new features or functionality good first issue Issues identified as good for first-time contributors snippets labels Jan 7, 2019
@jamesgeorge007
Copy link
Contributor

@jrieken Can you guide me on resolving this issue?

@jrieken
Copy link
Member

jrieken commented Jan 7, 2019

sure, checkout

jamesgeorge007 added a commit to jamesgeorge007/vscode that referenced this issue Jan 9, 2019
@vscodebot vscodebot bot locked and limited conversation to collaborators Feb 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality good first issue Issues identified as good for first-time contributors help wanted Issues identified as good community contribution opportunities snippets
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants