Fix DAG documentation rendering and description_md inline code in trigger modal#69138
Open
bramhanandlingala wants to merge 3 commits into
Open
Fix DAG documentation rendering and description_md inline code in trigger modal#69138bramhanandlingala wants to merge 3 commits into
bramhanandlingala wants to merge 3 commits into
Conversation
03b4395 to
40986ad
Compare
Member
There was a problem hiding this comment.
Thanks for the PR
Please include screenshots, before and after. (also screenshot of other places where we render markdown, to check side effects)
Also just limit the diff to the problem mentioned (param doc having too many blank lines).
The change around the 'Dag Doc' should be in their own PR and are not related to fixing the issue.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #69116
While working with Param description_md in Airflow 3, I noticed that
inline code like
namewas getting extra blank lines before and afterit instead of rendering inline. Also DAG Docs were not showing in the
trigger popup at all, and the dialog was too narrow for longer descriptions.
Root Cause
The inline code issue was caused by p={2} in ReactMarkdown.tsx which
adds 8px padding on all sides including top and bottom. This causes the
line height to break inside a p element making it look like paragraph
breaks around every inline code span.
For DAG Docs, the modal was already fetching dag.doc_md via
useDagServiceGetDag but never rendering it anywhere in the dialog.
For the narrow dialog, Dialog.Content had no width override so it was
using Chakra default width which is too small for longer descriptions.
Changes
ReactMarkdown.tsx
visually distinct from normal text
TriggerDAGModal.tsx
top of the modal when DAG documentation exists
components.json
Type of change