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.

Sign up for GitHub

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

Jump to bottom

Notebook renderer inline docs should explain why I would care about additional properties in RendererApi #125255

Closed
alexr00 opened this issue Jun 2, 2021 · 3 comments · Fixed by DefinitelyTyped/DefinitelyTyped#53589
Closed

Notebook renderer inline docs should explain why I would care about additional properties in RendererApi #125255

alexr00 opened this issue Jun 2, 2021 · 3 comments · Fixed by DefinitelyTyped/DefinitelyTyped#53589
Assignees
@mjbvz
Labels
bug Issue identified by VS Code Team member as probable bug verification-found Issue verification failed verified Verification succeeded
Milestone
May 2021

Comments

@alexr00
Copy link
Member

alexr00 commented Jun 2, 2021

Testing #124995

I am a bit of a notebooks noob, so I have no idea why I would ever care about the additional properties that I can set in RendererApi. A short sentence giving an example for why I would want others to consume these properties would help.

    /**
     * Additional properties may be returned for others to consume in
     * {@link RendererContext.getRenderer}.
     */
    [key: string]: unknown;
@jrieken jrieken assigned mjbvz and unassigned jrieken Jun 2, 2021
@mjbvz mjbvz added this to the May 2021 milestone Jun 3, 2021
mjbvz added a commit to mjbvz/DefinitelyTyped that referenced this issue Jun 3, 2021
@mjbvz
Update vscode-notebook-render for newest API
cefd917 
Follow up on microsoft/vscode#125351
Fixes microsoft/vscode#125255
@mjbvz mjbvz mentioned this issue Jun 3, 2021
Merged
8 tasks
typescript-bot pushed a commit to DefinitelyTyped/DefinitelyTyped that referenced this issue Jun 3, 2021
@mjbvz
🤖 Merge PR #53589 Update vscode-notebook-render for newest API by @mjbvz
bb847fd 


Follow up on microsoft/vscode#125351
Fixes microsoft/vscode#125255
@mjbvz
Copy link
Collaborator

mjbvz commented Jun 3, 2021

Fixed by DefinitelyTyped/DefinitelyTyped#53589

@mjbvz mjbvz closed this as completed Jun 3, 2021
@mjbvz mjbvz added the bug Issue identified by VS Code Team member as probable bug label Jun 3, 2021
@alexr00
Copy link
Member Author

alexr00 commented Jun 4, 2021

Looks like something is missing. There's a "For example," that doesn't have a following example.
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e816fb5bc134b509c00e15429156f34ca2bc6cbd/types/vscode-notebook-renderer/index.d.ts#L127-L134

@alexr00 alexr00 reopened this Jun 4, 2021
@alexr00 alexr00 added the verification-found Issue verification failed label Jun 4, 2021
@mjbvz
Copy link
Collaborator

mjbvz commented Jun 4, 2021

Remove extra words with DefinitelyTyped/DefinitelyTyped#53625

@mjbvz mjbvz closed this as completed Jun 4, 2021
@alexr00 alexr00 added the verified Verification succeeded label Jun 7, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jul 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mjbvz mjbvz

Labels
bug Issue identified by VS Code Team member as probable bug verification-found Issue verification failed verified Verification succeeded
Projects
None yet
Milestone
May 2021
Development

Successfully merging a pull request may close this issue.

Update vscode-notebook-render for newest API mjbvz/DefinitelyTyped
3 participants
@jrieken @mjbvz @alexr00