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

show api documentation on mouse click #2929

Merged
merged 2 commits into from
Apr 12, 2024
Merged

show api documentation on mouse click #2929

merged 2 commits into from
Apr 12, 2024

Conversation

devoncarew
Copy link
Member

  • show api documentation on mouse click

On a mouse click, request api docs from the server and render into a panel at the bottom of the editor. On a mouse click in whitespace, hide the doc panel.

We may consider moving this panel - and the console output panel - to using a split view in the future, to allow for user re-sizing.


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

Screenshot 2024-04-03 at 9 57 51 AM Screenshot 2024-04-03 at 9 57 18 AM

@parlough parlough self-requested a review April 3, 2024 17:22
Copy link
Member

@parlough parlough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, thanks!

The one thing that stood out to me that would be nice to improve later, either with user resizing or otherwise, was the panel being the same size even if there was only a title and no doc comment, such as for a local variable with just its type.

pkgs/sketch_pad/lib/docs.dart Show resolved Hide resolved
pkgs/sketch_pad/lib/docs.dart Outdated Show resolved Hide resolved
@devoncarew devoncarew merged commit af31f6b into main Apr 12, 2024
4 checks passed
@devoncarew devoncarew deleted the show_api_docs branch April 12, 2024 15:48
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

Successfully merging this pull request may close these issues.

None yet

2 participants