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

Fix formatting of many tables within the documentation #1810

Merged
merged 18 commits into from
Jun 28, 2022

Conversation

jordynmackool
Copy link
Contributor

@jordynmackool jordynmackool commented Apr 21, 2022

Fixes #1817

This PR is [ready] for review.

Risk

This PR makes [no] API changes.

Testing Plan

Updates to the tables within the documentation can be reviewed in the below links on testing (note permission will be needed to view the testing site if you don't have it; please reach out to me):

Unit Tests

N/A

Core Tests

N/A

Core version / branch / commit hash / module tested against: N/A
HMI name / version / branch / commit hash / module tested against: N/A

Summary

Fixing formatting of many tables within the documentation.

Changelog

Breaking Changes
  • [N/A]
Enhancements
  • [N/A]
Bug Fixes
  • [N/A]

Tasks Remaining: N/A

CLA

@jordynmackool jordynmackool marked this pull request as draft April 21, 2022 15:07
@codecov
Copy link

codecov bot commented Apr 21, 2022

Codecov Report

Merging #1810 (367f2ec) into release/5.5.0_RC (0bda034) will decrease coverage by 0.31%.
The diff coverage is 27.35%.

❗ Current head 367f2ec differs from pull request most recent head d6553ff. Consider uploading reports for the commit d6553ff to get more accurate results

Impacted file tree graph

@@                  Coverage Diff                   @@
##             release/5.5.0_RC    #1810      +/-   ##
======================================================
- Coverage               54.37%   54.05%   -0.32%     
- Complexity               5498     5529      +31     
======================================================
  Files                     562      562              
  Lines                   25466    25809     +343     
  Branches                 3317     3395      +78     
======================================================
+ Hits                    13847    13952     +105     
- Misses                  10360    10587     +227     
- Partials                 1259     1270      +11     
Impacted Files Coverage Δ
...icelink/managers/lockscreen/LockScreenManager.java 46.74% <0.00%> (ø)
...tdevicelink/managers/video/VideoStreamManager.java 21.87% <0.00%> (-0.53%) ⬇️
...managers/video/resolution/VideoStreamingRange.java 52.72% <0.00%> (ø)
...icelink/transport/MultiplexBluetoothTransport.java 4.23% <ø> (ø)
...link/transport/USBAccessoryAttachmentActivity.java 0.00% <0.00%> (ø)
...artdevicelink/transport/utl/SdlDeviceListener.java 7.81% <0.00%> (-0.13%) ⬇️
...in/java/com/smartdevicelink/util/AndroidTools.java 19.17% <0.00%> (-1.72%) ⬇️
...a/com/smartdevicelink/managers/BaseSdlManager.java 49.24% <0.00%> (-0.57%) ⬇️
...tdevicelink/managers/file/UploadFileOperation.java 67.83% <0.00%> (ø)
...anagers/lifecycle/BaseSystemCapabilityManager.java 67.67% <ø> (ø)
... and 60 more

@jordynmackool jordynmackool marked this pull request as ready for review June 23, 2022 19:52
@jordynmackool jordynmackool changed the base branch from master to develop June 23, 2022 20:02
@joeljfischer joeljfischer added bug A defect in the library documentation Relating to inline documentation labels Jun 27, 2022
@joeljfischer joeljfischer added this to In progress in 5.4.0 via automation Jun 27, 2022
@theresalech theresalech removed this from In progress in 5.4.0 Jun 27, 2022
@theresalech theresalech changed the base branch from develop to release/5.5.0_RC June 27, 2022 14:35
@theresalech theresalech added this to Review In Progress in 5.5.0 Jun 27, 2022
Copy link
Contributor

@noah-livio noah-livio left a comment

Choose a reason for hiding this comment

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

The table formatting is improved and looks a lot better.

The code formatting is inconsistent across files overall and could use a full reformat and refactor in the future, but we'll have to ignore that for now.

I found a few things that do not match RPC Spec and I am able to leave comments for

jordynmackool and others added 3 commits June 28, 2022 12:12
Co-authored-by: noah-livio <95378272+noah-livio@users.noreply.github.com>
…on.java

Co-authored-by: noah-livio <95378272+noah-livio@users.noreply.github.com>
…on.java

Co-authored-by: noah-livio <95378272+noah-livio@users.noreply.github.com>
jordynmackool and others added 2 commits June 28, 2022 12:16
…on.java

Co-authored-by: noah-livio <95378272+noah-livio@users.noreply.github.com>
…on.java

Co-authored-by: noah-livio <95378272+noah-livio@users.noreply.github.com>
Copy link
Contributor

@noah-livio noah-livio left a comment

Choose a reason for hiding this comment

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

The tables look good and my requested changes have been implemented

@noah-livio noah-livio merged commit c94b54c into release/5.5.0_RC Jun 28, 2022
@noah-livio noah-livio deleted the Fix-broken-tables branch June 28, 2022 17:42
@jordynmackool jordynmackool moved this from Review In Progress to Done in 5.5.0 Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A defect in the library documentation Relating to inline documentation
Projects
No open projects
5.5.0
Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants