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

Update discovery documentation #105

Merged
merged 1 commit into from
Jul 18, 2016
Merged

Update discovery documentation #105

merged 1 commit into from
Jul 18, 2016

Conversation

sagikazarmark
Copy link
Member

No description provided.


The package supports multiple discovery strategies and comes with two out-of-the-box:

- A built-in strategy with official HTTPlug components
Copy link
Contributor

Choose a reason for hiding this comment

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

"A built-in strategy supporting the HTTPlug adapters for the most common HTTP clients Guzzle 6 and Diactoros." (i think being specific in this place will be helpful, even at the risk that the list could grow out of sync.)

Copy link
Member

Choose a reason for hiding this comment

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

Not sure this is needed. It just creates an other list to maintain. I suggest no change.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think @dbu rather meant the most common PSR7 implementations in this case. I don't think it's wrong, actually it's marketing. 😛

@@ -62,8 +87,8 @@ Common Errors
Puli Factory is not available
Copy link
Member Author

Choose a reason for hiding this comment

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

Is this still a thing @Nyholm?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. But only as "previous exception" See comment: php-http/discovery#59 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, should we reflect that in the docs?

Copy link
Member

Choose a reason for hiding this comment

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

I think it is good as it is.

But we should add docs about the "DiscoveryFailedException" and maybe rewrite the "NotFoundException" a bit.

Copy link
Member Author

Choose a reason for hiding this comment

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

I would like to get this merged ASAP. I created #116

Copy link
Member

Choose a reason for hiding this comment

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

Good!

@sagikazarmark
Copy link
Member Author

Someone pls do a final review

@dbu dbu merged commit 3c7d703 into master Jul 18, 2016
@dbu dbu deleted the discovery_puli_optional branch July 18, 2016 06:39
@dbu
Copy link
Contributor

dbu commented Jul 18, 2016

thanks for keeping the doc in sync !

once there is a stable 1.0 version, we should add versionadded blocks when we add new features, to make the doc useful and understandable for existing users. with pre-1.0 versions we should not bother or we clutter docs with too much information.

@sagikazarmark
Copy link
Member Author

I added only one: the NotFoundException deprecation

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.

3 participants