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

Ensure the tutorial snippets have a proper height #836

Merged
merged 1 commit into from
Jan 22, 2022
Merged

Conversation

dkotter
Copy link
Collaborator

@dkotter dkotter commented Jan 21, 2022

Description of the Change

We have some tutorial snippets that were added to our automated doc site a few months back but there's currently a styling issue there where the full snippet doesn't show. The issue is with some CSS that is forcing a height of 16px, so if the code container needs to be bigger than that, the text gets cut off.

This PR fixes that by changing the height style to a min-height style. As far as I can tell, this has no impact on the other sections of that doc site but unsure why that style was added in the first place.

Before:

before

After:

after

Alternate Designs

None

Possible Drawbacks

Potential that other places on the docs site relies on that style and could be negatively impacted

Verification Process

  1. Checkout this PR locally
  2. Run npm install
  3. Run npm run build:docs
  4. In the resulting docs-built directory, find the tutorial-snippets.html file and open in a browser. Ensure the snippets fully display (can compare to this)

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

@dkotter dkotter self-assigned this Jan 21, 2022
@jeffpaul
Copy link
Member

Sheesh, that's much better, nice fix!

Props @dkotter @pcrumm.

@jeffpaul jeffpaul added this to the 1.7.0 milestone Jan 22, 2022
@jeffpaul jeffpaul merged commit 0cc8a5b into develop Jan 22, 2022
@jeffpaul jeffpaul deleted the fix/doc-styling branch January 22, 2022 00:34
@jeffpaul jeffpaul modified the milestones: 1.7.0, 1.6.8 Feb 1, 2022
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