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(doc): Avoid unnecessary line-wrapping in schema docs #698

Merged
merged 3 commits into from
Jul 31, 2020

Conversation

untitaker
Copy link
Member

@untitaker untitaker commented Jul 30, 2020

schemars does some funny text processing that destroys our beautiful hand-crafted markdown. Fork that dependency, add option to disable the behavior and use it here.

GREsau/schemars#45

@untitaker untitaker requested a review from a team July 30, 2020 21:46
@@ -22,7 +22,7 @@ lru = "0.4.0"
parking_lot = "0.10.0"
regex = "1.3.9"
sentry-types = "0.14.1"
schemars = { version = "0.7.1", features = ["uuid", "chrono"], optional = true }
schemars = { version = "0.8.0-alpha-4", git = "https://github.com/untitaker/schemars", branch = "preserve-formatting", features = ["uuid", "chrono"], optional = true }
Copy link
Member

Choose a reason for hiding this comment

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

I'm wondering if it would make sense to re-export schemars as a module of relay-common, just like we do with uuid and some others. Given that we need it to be absolutely compatible across the crates, I think that would make sense.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah was wondering how to do that. One problem is schemars_derive which I am not sure how to reexport.

Copy link
Member Author

Choose a reason for hiding this comment

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

It does fail to compile very spectacularly if there's a version split though, so that's good.

@untitaker untitaker merged commit f5a42c3 into master Jul 31, 2020
@untitaker untitaker deleted the fix/line-wrapping branch July 31, 2020 07:36
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.

2 participants