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: Fix the documentation to not show the mermaid tooltip clipping at the top of each page with an inheritance diagram #354

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Nov 22, 2024

Proposed changes

fix: Fix the documentation to not show the mermaid tooltip clipping at the top of each page with an inheritance diagram

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Functionality update (non-breaking change which updates or changes existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have created (or updated) an Issue to track the status of this update/change and updated the link in this PR description (see above in the Proposed changes section) using the wording Addresses #<issue_number>
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

…t the top of each page with an inheritance diagram
@nfelt14 nfelt14 requested a review from a team as a code owner November 22, 2024 20:45
@tek-githubbot-1010 tek-githubbot-1010 requested a review from a team November 22, 2024 20:45
@nfelt14 nfelt14 enabled auto-merge (squash) November 22, 2024 20:46
Copy link

codecov bot commented Nov 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (053f735) to head (1e6058d).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #354   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          161       161           
  Lines         4645      4645           
  Branches       777       777           
=========================================
  Hits          4645      4645           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 merged commit 644396b into tektronix:main Nov 22, 2024
72 checks passed
Copy link

github-actions bot commented Nov 22, 2024

Test Results (macos)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 101 101
tests/test_alternative_connection_addresses.py 19 19
tests/test_awgs.py 4 4
tests/test_config_parser.py 40 40
tests/test_device_manager.py 17 17
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_extension_mixin.py 1 1
tests/test_generate_waveform.py 6 6
tests/test_helpers.py 72 72
tests/test_ieee_scpi_cmds.py 1 1
tests/test_logging.py 4 4
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 9 9
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 425 425
tests/test_unsupported_device_type.py 1 1
tests/test_verification_functions.py 6 6
TOTAL 735 735

Link to workflow run

Copy link

github-actions bot commented Nov 22, 2024

Test Results (windows)

path passed subtotal
tests\test_afgs.py 2 2
tests\test_alias_dict.py 1 1
tests\test_all_device_drivers.py 101 101
tests\test_alternative_connection_addresses.py 19 19
tests\test_awgs.py 4 4
tests\test_config_parser.py 40 40
tests\test_device_manager.py 17 17
tests\test_devices_legacy_tsp_ieee_cmds.py 3 3
tests\test_extension_mixin.py 1 1
tests\test_generate_waveform.py 6 6
tests\test_helpers.py 72 72
tests\test_ieee_scpi_cmds.py 1 1
tests\test_logging.py 4 4
tests\test_margin_testers.py 5 5
tests\test_pi_device.py 1 1
tests\test_psu.py 1 1
tests\test_rest_api_device.py 10 10
tests\test_scopes.py 9 9
tests\test_singleton.py 1 1
tests\test_smu.py 4 4
tests\test_ss.py 1 1
tests\test_tm_devices.py 425 425
tests\test_unsupported_device_type.py 1 1
tests\test_verification_functions.py 6 6
TOTAL 735 735

Link to workflow run

Copy link

github-actions bot commented Nov 22, 2024

Test Results (ubuntu)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 101 101
tests/test_alternative_connection_addresses.py 19 19
tests/test_awgs.py 4 4
tests/test_config_parser.py 40 40
tests/test_device_manager.py 17 17
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_extension_mixin.py 1 1
tests/test_generate_waveform.py 6 6
tests/test_helpers.py 72 72
tests/test_ieee_scpi_cmds.py 1 1
tests/test_logging.py 4 4
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 9 9
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 425 425
tests/test_unsupported_device_type.py 1 1
tests/test_verification_functions.py 6 6
TOTAL 735 735

Link to workflow run

@nfelt14 nfelt14 deleted the documentation-mermaid-updates branch November 25, 2024 16:24
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.

2 participants