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

Added link to spec, removed contents that is in spec and out of date #169

Closed
wants to merge 1 commit into from

Conversation

FroMage
Copy link
Contributor

@FroMage FroMage commented Jul 15, 2019

This could be enough to fix #161.

I added a badge to the rendered spec, and removed all the outdated content that is in the spec.

Do you guys think we need more text in the README?

@FroMage FroMage requested a review from njr-11 July 15, 2019 15:35
* Status: *new*
* Decision Notes:
https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!topic/microprofile/jKFu-IS_U90[Discussion
thread topic with background and covering the design]
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for catching the out-of-date material and removing it. I agree with removing the above, however, removing what follows after this would leave us with an empty doc on the main page, so I think it would be better to just update more specific out-of-date wording. I'll add some review comments below attempting to do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought that initially too, except we do have a link to the rendered spec so it's easy to get to the info, and whatever we duplicate here will always end up out-of-date.

I think this file should concentrate on things that are not in the spec.

A short intro of a single paragraph should be fine, though.

Introduction
~~~~~~~~~~~~

The proposal introduces APIs for obtaining CompletableFutures that are
Copy link
Contributor

Choose a reason for hiding this comment

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

can change "The proposal" to "This specification"

Builders
^^^^^^^^^

It shall be possible to build instances of ManagedExecutor and
Copy link
Contributor

Choose a reason for hiding this comment

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

"It shall be possible to ..." can change to, "With MicroProfile Context Propagation, you can ..."

@kenfinnigan kenfinnigan deleted the readme-changes branch October 16, 2019 14: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.

Publish the spec and javadoc
3 participants