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

WRO-745: Clean up Spotlight document #3069

Merged
merged 7 commits into from Jul 7, 2022
Merged

WRO-745: Clean up Spotlight document #3069

merged 7 commits into from Jul 7, 2022

Conversation

jeonghee27
Copy link
Contributor

@jeonghee27 jeonghee27 commented Jun 30, 2022

Checklist

  • I have read and understand the contribution guide
  • A CHANGELOG entry is included
  • At least one test case is included for this feature or bug fix
  • Documentation was added or is not needed
  • This is an API breaking change

Issue Resolved / Feature Added

There is duplicated api description on Spotlight/index.md files.

Resolution

  • Leave only the APIs that are mainly used and remove others.
  • Add link for full api list
  • Merge some docs in SpotlightContainerDecorator.js (There was nothing to merge in the Spottable docs.)
  • In the md document, the term "Parameters" is used, but in the api documents and code, the term "Configuration" is used. So, I modified it to use "Configuration Parameters."

Additional Considerations

restrict is not an officially provided config, but it is used for initial setting in many places. (even in the Spotlight example)
So I thought restrict should be added to the SpotlightContainerDecorator docs

Links

WRO-745

Comments

Enact-DCO-1.0-Signed-off-by: Jeonghee Ahn (jeonghee27.ahn@lge.com)

Enact-DCO-1.0-Signed-off-by: Jeonghee Ahn (jeonghee27.ahn@lge.com)
@codecov
Copy link

codecov bot commented Jun 30, 2022

Codecov Report

Merging #3069 (6f6d55b) into develop (c642aa8) will increase coverage by 0.43%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #3069      +/-   ##
===========================================
+ Coverage    48.08%   48.51%   +0.43%     
===========================================
  Files          171      171              
  Lines         9719     9860     +141     
  Branches      2609     2686      +77     
===========================================
+ Hits          4673     4784     +111     
- Misses        3959     3966       +7     
- Partials      1087     1110      +23     
Impacted Files Coverage Δ
...tContainerDecorator/SpotlightContainerDecorator.js 100.00% <ø> (ø)
packages/spotlight/src/container.js 84.61% <0.00%> (-0.60%) ⬇️
packages/spotlight/Spottable/useSpottable.js 96.00% <0.00%> (+1.88%) ⬆️
packages/i18n/src/Loader.js 63.36% <0.00%> (+4.25%) ⬆️
packages/ui/useScroll/Scrollbar.js 75.00% <0.00%> (+4.41%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c642aa8...6f6d55b. Read the comment docs.

jeonghee27 and others added 2 commits July 1, 2022 15:49
Enact-DCO-1.0-Signed-off-by: Seungho Park <seunghoh.park@lge.com>
Copy link
Member

@seunghoh seunghoh left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@MikyungKim MikyungKim left a comment

Choose a reason for hiding this comment

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

:lgtm:

@MikyungKim MikyungKim changed the title WRO-745: remove redundant api list on Spotlight document WRO-745: Clean up Spotlight document Jul 7, 2022
@MikyungKim MikyungKim merged commit 58af100 into develop Jul 7, 2022
@MikyungKim MikyungKim deleted the feature/WRO-745 branch July 7, 2022 08:21
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

3 participants