Skip to content

Fix/mermaid support doc#58

Merged
soniacq merged 2 commits intomainfrom
fix/mermaid_support_doc
May 27, 2025
Merged

Fix/mermaid support doc#58
soniacq merged 2 commits intomainfrom
fix/mermaid_support_doc

Conversation

@simonprovost
Copy link
Member

@simonprovost simonprovost commented May 22, 2025

Urban Pipeline is quite a substantial component of Urban Mapper. It therefore deserves attention. We first fix an issue with mermaid and material for mkdocs (plugin related). Then we made sure that the viz. is substantial enough to understand the capabilities of the urban pipeline.

Cheers :)


📚 Documentation preview 📚: https://UrbanMapper--58.org.readthedocs.build/en/58/

@simonprovost simonprovost requested a review from soniacq May 22, 2025 18:41
@simonprovost simonprovost self-assigned this May 22, 2025
@simonprovost simonprovost added bug Something isn't working documentation Improvements or additions to documentation labels May 22, 2025
@simonprovost simonprovost force-pushed the fix/mermaid_support_doc branch from a1c916d to 58eb62e Compare May 22, 2025 18:46
@simonprovost simonprovost force-pushed the fix/mermaid_support_doc branch 2 times, most recently from 0c33627 to 6fa5765 Compare May 22, 2025 18:59
Copy link
Contributor

@soniacq soniacq left a comment

Choose a reason for hiding this comment

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

Since there are only two possibilities — either including a visualiser or not — using '(0..1)' may be misleading, as it implies a continuous range or multiple values between 0 and 1. Consider replacing it with something more explicit like 'Visualiser (0, 1)' to indicate a binary choice.

@soniacq
Copy link
Contributor

soniacq commented May 27, 2025

Enhance the PR description. It doesn't have to be extensive—just a sentence summarizing the changes.

@simonprovost simonprovost force-pushed the fix/mermaid_support_doc branch from 6fa5765 to 42d7a33 Compare May 27, 2025 13:29
@simonprovost
Copy link
Member Author

Since there are only two possibilities — either including a visualiser or not — using '(0..1)' may be misleading, as it implies a continuous range or multiple values between 0 and 1. Consider replacing it with something more explicit like 'Visualiser (0, 1)' to indicate a binary choice.

Allright @soniacq it's ready :) Thanks for this suggestion it was indeed confusing now that you mentioned it 🫡

Copy link
Contributor

@soniacq soniacq left a comment

Choose a reason for hiding this comment

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

Great! Thanks, @simonprovost. Feel free to merge this PR.

@soniacq soniacq merged commit c2ef13d into main May 27, 2025
8 checks passed
@soniacq soniacq deleted the fix/mermaid_support_doc branch June 24, 2025 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants