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

Add 1.1 feature support matrix #111

Merged
merged 1 commit into from
Jan 2, 2019
Merged

Add 1.1 feature support matrix #111

merged 1 commit into from
Jan 2, 2019

Conversation

paddybyers
Copy link
Member

No description provided.

@mattheworiordan
Copy link
Member

@paddybyers I added @Srushtika and @SimonWoolf to this PR for review.

I think we can do better than this for a few reasons:

  • Why is Feature support the most important thing shown to a new developer who uses this client library. That is not the most important thing they need to know about, both because someone new to a library probably wants to know how to use it & install it first, but also because why are we focussing on the negative (of what's missing) first.
  • There is no need to show users what features are supported, only what is not supported. A user is not arriving knowing anything about our release schedules in most cases. All they care about is the things I mentioned above, and any caveats. This section should be a caveat. I do think we should consider a separate table we maintain in one place which keeps a list of all unsupported features across all libraries in one place, but we can do that once the missing feature bit is done for all libs.
  • You state "The 1.1 specification includes multiple new features, and this library implements a subset of those features as follows.". As above, the reader doesn't know about 1.0 or 0.8. So this is not needed.
  • You state "The 1.1 specification also contains numerous spec clarifications, corrections and minor feature additions.". The reader does not care. Who is this README for?

@mattheworiordan
Copy link
Member

@paddybyers ^?

@paddybyers
Copy link
Member Author

@mattheworiordan updated: 0017497

Copy link
Member

@mattheworiordan mattheworiordan left a comment

Choose a reason for hiding this comment

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

This is brilliant, thanks @paddybyers.

@paddybyers paddybyers merged commit 467e1c2 into develop Jan 2, 2019
@paddybyers paddybyers deleted the 1-1-feature-matrix branch January 2, 2019 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants