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

feat: support markdown descriptions #18

Merged
merged 1 commit into from
Dec 17, 2023
Merged

Conversation

twelvelabs
Copy link
Owner

  • Adds support for multi-line and markdown descriptions in property tables by converting them to inline HTML. Previously any newlines in the description would break the table formatting (lol/sob, markdown).
  • Adds support for the enumDescriptions property. It's not officially part of the JSON schema spec, but it's in common use and supported by other tools.
  • Adds examples to the description column in property tables when present.

Copy link

codecov bot commented Dec 17, 2023

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (c174ba4) 87.00% compared to head (12fa124) 87.67%.
Report is 2 commits behind head on main.

Files Patch % Lines
internal/markdown/markdown.go 84.21% 4 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #18      +/-   ##
==========================================
+ Coverage   87.00%   87.67%   +0.67%     
==========================================
  Files           8        9       +1     
  Lines         631      698      +67     
==========================================
+ Hits          549      612      +63     
- Misses         63       64       +1     
- Partials       19       22       +3     

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

@twelvelabs twelvelabs merged commit 22c440d into main Dec 17, 2023
3 checks passed
@twelvelabs twelvelabs deleted the markdown-descriptions branch December 17, 2023 21:11
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.

1 participant