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

Replace special symbol characters with other characters to allow them to be drawn as mermaid #85

Merged
merged 5 commits into from
Feb 10, 2024

Conversation

syou6162
Copy link
Contributor

@syou6162 syou6162 commented Feb 9, 2024

resolves #81

Description

Mermaid may not be able to render special characters. To deal with such cases, we have made changes to replace or omit special characters.

Checklist

  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • I have opened an issue to add/update docs, or docs changes are not required/relevant for this PR

@syou6162 syou6162 changed the title Feature/replace special characters Replace special symbol characters with other characters to allow them to be drawn as mermaid Feb 9, 2024
@syou6162 syou6162 force-pushed the feature/replace_special_characters branch 2 times, most recently from 092f03e to 6e9f129 Compare February 9, 2024 17:41
@syou6162 syou6162 force-pushed the feature/replace_special_characters branch from 6e9f129 to 61d8ae1 Compare February 9, 2024 17:45
Copy link

codecov bot commented Feb 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a6cf5f4) 85.68% compared to head (d5a402f) 100.00%.
Report is 8 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##             main       #85       +/-   ##
============================================
+ Coverage   85.68%   100.00%   +14.31%     
============================================
  Files          31        31               
  Lines         915       930       +15     
============================================
+ Hits          784       930      +146     
+ Misses        131         0      -131     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@syou6162 syou6162 force-pushed the feature/replace_special_characters branch from 375a82d to 63e45bb Compare February 9, 2024 18:00
return None


def replace_column_type(column_type: str) -> str:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are many possible ways to abbreviate or omit this character, and it may be possible to change it from an environment variable or command line argument. However, we want to start out with a simple form.

@syou6162 syou6162 marked this pull request as ready for review February 9, 2024 18:07
@datnguye
Copy link
Owner

LGTM for the code changes, thanks for your proactive contribution so far @syou6162 ❤️

I will create v1.11.0b1 right after this gets merged

@syou6162 syou6162 force-pushed the feature/replace_special_characters branch 2 times, most recently from 6da2b40 to e456855 Compare February 10, 2024 06:18
@syou6162 syou6162 force-pushed the feature/replace_special_characters branch from e456855 to d5a402f Compare February 10, 2024 06:22
@datnguye datnguye merged commit f553725 into datnguye:main Feb 10, 2024
12 checks passed
@syou6162 syou6162 deleted the feature/replace_special_characters branch February 10, 2024 07:07
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.

[FEAT] Replace special symbol characters with other characters to allow them to be drawn as mermaid
2 participants