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 flowchart alignment #109

Merged
merged 3 commits into from
Jul 18, 2022
Merged

🎨 Fix flowchart alignment #109

merged 3 commits into from
Jul 18, 2022

Conversation

Glutexo
Copy link
Owner

@Glutexo Glutexo commented Jul 15, 2022

Aligned the flowchart sides and arrows.

The aligning whitespace is pretty but hardly sustainable.
@Glutexo Glutexo requested a review from nappex July 15, 2022 13:43
@Glutexo Glutexo self-assigned this Jul 15, 2022
@Glutexo Glutexo changed the title Remove redundant Mermaid whitespace 🎨 Remove redundant Mermaid whitespace Jul 15, 2022
@Glutexo Glutexo added the documentation Improvements or additions to documentation label Jul 15, 2022
Copy link
Collaborator

@nappex nappex left a comment

Choose a reason for hiding this comment

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

it was made for better readability, do you think it has not a worth?

@Glutexo
Copy link
Owner Author

Glutexo commented Jul 15, 2022

It certainly had with the very first version of the flowchart. Now, if you want to amend it, you need to reformat whitespace on all the lines, which seems rather impractical. Just look how broken it was before this Pull Request. The position of the top and bottom arrows is off, and so is the alignment of the right side.

     START             -->           operator(OPERATOR)
     operator    -- <hash>.urls --->    downloader(DOWNLOADER)
     downloader  -- <hash>.raw --->      parser(PARSER)
     parser      -- <hash>.json -->       operator
     operator           -->          MATERIALIZATION

nappex
nappex previously approved these changes Jul 17, 2022
Copy link
Collaborator

@nappex nappex left a comment

Choose a reason for hiding this comment

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

alright, flowchart is not so complicated... to stick on the readability.

Align the flowchart sides and arrows instead of collapsing the whitespace.
@Glutexo
Copy link
Owner Author

Glutexo commented Jul 17, 2022

Instead of collapsing the whitespace, I cleaned up the aligned version. Although it looks nice, I am afraid the maintainability won’t be high. But we can revisit the formatting once it becomes a real problem. Thank you for your input!

@Glutexo Glutexo changed the title 🎨 Remove redundant Mermaid whitespace 🎨 Fix flowchart alignment Jul 17, 2022
@Glutexo Glutexo requested a review from nappex July 17, 2022 17:06
@Glutexo Glutexo merged commit 3096462 into master Jul 18, 2022
@Glutexo Glutexo deleted the flowchart-formatting branch July 18, 2022 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants