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

Addresses issue #694 #859

Merged
merged 8 commits into from
Dec 16, 2024
Merged

Addresses issue #694 #859

merged 8 commits into from
Dec 16, 2024

Conversation

shruti862
Copy link
Contributor

@shruti862 shruti862 commented Dec 9, 2024

Description

I added Overview and Usage section on KTooltip documentation page

Issue addressed

Fixes issue #694

Addresses PR #853

Before/after screenshots

Changelog

Steps to test

  1. Step 1
  2. Step 2
  3. ...

(optional) Implementation notes

At a high level, how did you implement this?

Does this introduce any tech-debt items?

Testing checklist

  • 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

@MisRob MisRob self-requested a review December 9, 2024 15:48
@MisRob MisRob self-assigned this Dec 9, 2024
@MisRob MisRob added the TODO: needs review Waiting for review label Dec 9, 2024
Copy link
Member

@MisRob MisRob 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 for getting this ready @shruti862. Overall looks great and describes all scenarios requested in the issue. I suggest few tweaks regarding casing, conciseness, and clarity (writing guide has more information). You can submit most of them here in GitHub UI if you'd like.

docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
docs/pages/ktooltip.vue Outdated Show resolved Hide resolved
@shruti862
Copy link
Contributor Author

shruti862 commented Dec 16, 2024

@MisRob I have done all the suggested changes.

@MisRob MisRob self-requested a review December 16, 2024 11:18
Copy link
Member

@MisRob MisRob left a comment

Choose a reason for hiding this comment

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

Thanks @shruti862! I pulled in the latest develop and re-linted because of our recent Node version upgrade.

@MisRob MisRob merged commit 2eb8aff into learningequality:develop Dec 16, 2024
7 of 12 checks passed
learning-equality-bot bot pushed a commit that referenced this pull request Dec 16, 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.

2 participants