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

Docs: Edit example README and add comments in Basic Panel Plugin #236

Merged
merged 8 commits into from
Jan 19, 2024

Conversation

josmperez
Copy link
Contributor

Edit example README and add some code comments for Panel Basic Plugin template.

@josmperez josmperez added the documentation Improvements or additions to documentation label Dec 28, 2023
@josmperez josmperez self-assigned this Dec 28, 2023
@josmperez josmperez requested review from a team as code owners December 28, 2023 23:17
@josmperez josmperez requested review from mckn, wbrowne, andresmgot, oshirohugo and jackw and removed request for a team December 28, 2023 23:17
@josmperez josmperez changed the title Edit example README and add some code comments Edit example README and add some code comments in Basic Panel Plugin Dec 28, 2023
@josmperez josmperez changed the title Edit example README and add some code comments in Basic Panel Plugin Docs: Edit example README and add comments in Basic Panel Plugin Dec 28, 2023
Copy link
Contributor

@mckn mckn left a comment

Choose a reason for hiding this comment

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

Great work on this! Added a couple of comments. Consider them as suggestions from my side. I'm basically just thinking out loud.

examples/panel-basic/README.md Outdated Show resolved Hide resolved
examples/panel-basic/README.md Outdated Show resolved Hide resolved
examples/panel-basic/README.md Outdated Show resolved Hide resolved
examples/panel-basic/README.md Outdated Show resolved Hide resolved

export function SimplePanel({
options,
export function SimplePanel({ /** Takes in a list of props used in this example */
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
export function SimplePanel({ /** Takes in a list of props used in this example */
export function SimplePanel({

@josmperez josmperez requested review from mckn and academo January 12, 2024 22:57
Copy link
Member

@academo academo left a comment

Choose a reason for hiding this comment

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

@josmperez I pushed a commit fixing the npm commands and the rest looks good to me.

@josmperez josmperez merged commit d300937 into main Jan 19, 2024
23 of 24 checks passed
@josmperez josmperez deleted the josmperez/panel-basic-edit branch January 19, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

3 participants