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: Enable text wrapping in docstring header on smaller screens (#2293) #2307

Merged
merged 4 commits into from
Oct 29, 2023

Conversation

QuantuM410
Copy link
Contributor

Issue Link: #2293

Changes:

overflow: auto CSS property added to the header tag.

screen-recorder-tue-oct-24-2023-13-13-39.webm

Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

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

Thanks! This basically LGTM, but could you:

  1. Undo the unrelated formatting changes? I think the original formatting is preferred and more consistent with the rest of the code, and also I would prefer not to mix unrelated changes in PRs.
  2. Add a quick note about this into CHANGELOG.md.

@mortenpi mortenpi added Format: HTML Related to the default HTML output Type: Bugfix labels Oct 24, 2023
@QuantuM410
Copy link
Contributor Author

QuantuM410 commented Oct 24, 2023

Thanks! This basically LGTM, but could you:

1. Undo the unrelated formatting changes? I think the original formatting is preferred and more consistent with the rest of the code, and also I would prefer not to mix unrelated changes in PRs.

2. Add a quick note about this into `CHANGELOG.md`.

While I am adding the note in CHANGELOG.md, do I also have to run make changelog. Once I am running make changelog two lines are being added (one unrelated to the issue but is related to the previous fix in v1.1.2)
image

image

@mortenpi
Copy link
Member

Yeah, if you don't mind, run make changelog. And let's add the 2300 too here -- that was an oversight in the earlier PR.

@QuantuM410
Copy link
Contributor Author

@mortenpi I have updated the files with required changes

@mortenpi mortenpi enabled auto-merge (squash) October 29, 2023 05:50
Copy link
Member

@mortenpi mortenpi 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!

@mortenpi mortenpi linked an issue Oct 29, 2023 that may be closed by this pull request
@mortenpi mortenpi merged commit 5dafb64 into JuliaDocs:master Oct 29, 2023
20 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Bugfix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Long text in docstring does not wrap on smaller screens
2 participants