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

Adding documentation for the proto2 incompatibility #321

Merged
merged 5 commits into from
Aug 18, 2020
Merged

Conversation

dmarticus
Copy link
Contributor

I'd say this PR partially closes #162. TBH, today was my first day poking around with Skeuomorph, and I don't know enough about the existing design tradeoffs to know the extent of the incompatibilities between our library and the existing schema protocols. However, we do have one open issue (#218) that mentions the incompatibility between Proto3 and Proto2, and in lieu of changing the design of skeuomorph to support both protobuf protocols, adding the documentation around this behavior is a good first step in helping our users understand the intentional incompatibilities herein.

Super open to suggestions about what other known Skeuomorph incompatibilities exist, and would be happy to address them in this PR.

@codecov
Copy link

codecov bot commented Aug 18, 2020

Codecov Report

Merging #321 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #321   +/-   ##
=======================================
  Coverage   83.93%   83.93%           
=======================================
  Files          29       29           
  Lines        1899     1899           
  Branches       25       23    -2     
=======================================
  Hits         1594     1594           
  Misses        305      305           
Impacted Files Coverage Δ
...cala/higherkindness/skeuomorph/avro/Protocol.scala 31.81% <ø> (ø)
.../scala/higherkindness/skeuomorph/avro/schema.scala 57.62% <ø> (ø)
...cala/higherkindness/skeuomorph/openapi/print.scala 99.15% <100.00%> (ø)
...igherkindness/skeuomorph/protobuf/ParseProto.scala 96.42% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e46bd70...5eee2f3. Read the comment docs.

Copy link
Member

@pepegar pepegar left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @dmarticus !

Copy link
Member

@juanpedromoreno juanpedromoreno left a comment

Choose a reason for hiding this comment

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

:shipit: thanks @dmarticus !

@dmarticus dmarticus merged commit 88f8687 into master Aug 18, 2020
@dmarticus dmarticus deleted the dmarticus/162 branch August 18, 2020 13:37
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.

Add documentation
3 participants