Provide full signature help with highlighted parameter #416
Conversation
| @@ -55,8 +56,13 @@ export class PythonSignatureProvider implements vscode.SignatureHelpProvider { | |||
| signature.activeParameter = def.paramindex; | |||
| // Don't display the documentation, as vs code doesn't format the docmentation. | |||
| // i.e. line feeds are not respected, long content is stripped. | |||
| const docLines = def.docstring.splitLines(); | |||
| const label = docLines[0].trim(); | |||
| const documentation = docLines.length > 1 ? docLines.filter((line, index) => index > 0).join(EOL) : ''; | |||
There was a problem hiding this comment.
You could improve the code as follows:
const label = docLines.shift();
const documentation = docLines.join(EOL);| const sig = <vscode.SignatureInformation>{ | ||
| label: def.description, | ||
| label: label, | ||
| documentation: documentation, |
There was a problem hiding this comment.
instead of documentation: documentation, please use documentation,
That's the preferred style for object literals.
| @@ -65,7 +71,7 @@ export class PythonSignatureProvider implements vscode.SignatureHelpProvider { | |||
| } | |||
| return <vscode.ParameterInformation>{ | |||
| documentation: arg.docstring.length > 0 ? arg.docstring : arg.description, | |||
| label: arg.description.length > 0 ? arg.description : arg.name | |||
| label: arg.name | |||
There was a problem hiding this comment.
Lol, I hang my head in shame for this simple bug. 😞 . Nothing to do here.
|
@MikhailArkhipov looks good. will approve after the release. |
|
On Python 3.6 VSC gets different signature description which sometimes does not have signature in it. Looks like Jedi/Py3 issue. Ex (without new code) Stock Funny that |
|
@DonJayamanne could you please look one more time. I removed requirement for param name to be a |
src/test/index.ts
Outdated
| @@ -12,7 +12,8 @@ const options: MochaSetupOptions & { retries: number } = { | |||
| ui: 'tdd', | |||
| useColors: true, | |||
| timeout: 25000, | |||
| retries: 3 | |||
| retries: 3, | |||
| grep: 'Signatures' | |||
There was a problem hiding this comment.
@MikhailArkhipov please remove the grep once done it should be good. I'll approve this now. Just wanted to ensure you got this fixed before merging.
* upstream/master: Make use of new execution layer instead of spawning processes (#425) Use localhost instead of 0.0.0.0 for all local socket servers (#417) Provide full signature help with highlighted parameter (#416) Change `os.arch()` to `npm` `arch` to fix wrong arch detection. (#419) Document our Russian support (#424) Bump the version number to the next release as an alpha (#422) Russian translation (#411) Speed up virtual environment detection in workspace (#405)
Fix #70
Ignore Russian translation from pending PR