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

Documentation for kselect #821

Merged
merged 4 commits into from
Nov 28, 2024

Conversation

yeshwanth235
Copy link
Contributor

Description

Issue addressed

#664 (comment)

Addresses #PR# HERE

Before/after screenshots

Before
image

After
image

Changelog

Steps to test

  • Check the documentation for slots, emits, methods and props for kselect component. changes should be reflecting

(optional) Implementation notes

At a high level, how did you implement this?

Vue Docgen API generates JSDoc documentation for components.

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical and brittle code paths are covered by unit tests
  • The change is described in the changelog section above

Reviewer guidance

  • Is the code clean and well-commented?
  • Are there tests for this change?
  • Are all UI components LTR and RTL compliant (if applicable)?
  • Add other things to check for here

Comments

@yeshwanth235
Copy link
Contributor Author

Hi @AlexVelezLl, please help in reviewing

@MisRob
Copy link
Member

MisRob commented Nov 13, 2024

Hi @yeshwanth235, thanks! @AllanOXDi and @ozer550 would you please review, and @AlexVelezLl perhaps you could then give it a final look and merge?

@MisRob MisRob added the TODO: needs review Waiting for review label Nov 13, 2024
@MisRob
Copy link
Member

MisRob commented Nov 20, 2024

Hi @yeshwanth235, just chiming in to mention @AllanOXDi has review in progress (cc @AlexVelezLl). We will follow-up with you.

Copy link
Member

@AllanOXDi AllanOXDi left a comment

Choose a reason for hiding this comment

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

Hi @yeshwanth235, great work on this! I’ve added a few comments suggesting some improvements for your consideration.

lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
@AllanOXDi AllanOXDi self-requested a review November 21, 2024 13:55
Copy link
Member

@AllanOXDi AllanOXDi left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks @yeshwanth235

@AllanOXDi
Copy link
Member

@AlexVelezLl is there anything still missing on this PR - if not we can merge it

@yeshwanth235
Copy link
Contributor Author

yeshwanth235 commented Nov 22, 2024

Hi @AllanOXDi, PR approve was revoked by mistake 😅. Please help in approving again.

Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Thanks @yeshwanth235! Just some suggestions to make the wording consistent with the docs of other components 🤗, and some clarifications about some props that werent well described. After this, we can merge this PR :). Thank you!

@@ -43,6 +43,7 @@
:class="labelClasses"
:style="activeColorStyle"
>
<!-- @slot Displays the label -->
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<!-- @slot Displays the label -->
<!-- @slot Optional slot as alternative to `label` prop -->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I apologize for the delay in addressing the PR comments. The comments have now been addressed. Please review at your earliest convenience.

Copy link
Member

Choose a reason for hiding this comment

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

No worries @yeshwanth235. Thank you!! 🚀

lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
lib/KSelect/index.vue Outdated Show resolved Hide resolved
Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Thank you @yeshwanth235!! Looks good to me! 🚀🚀

@AlexVelezLl AlexVelezLl merged commit b5694c9 into learningequality:develop Nov 28, 2024
8 checks passed
learning-equality-bot bot pushed a commit that referenced this pull request Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants