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 browserkit component documentation #6072

Merged
merged 21 commits into from
Feb 9, 2016
Merged

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets -

This PR tries to finish the fantastic work made by @yamiko-ninja in #4312. Please review it so I can improve/finish it and we can merge it before year's end. Thanks!

The component only provides an abstract client and does not provide any backend
ready to use for the HTTP layer.

To create your own client you must extend the abstract client class and
Copy link
Member

Choose a reason for hiding this comment

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

"[...] own client, you must [...]"

Copy link
Member

Choose a reason for hiding this comment

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

Maybe "client class" -> "Client class"

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@wouterj
Copy link
Member

wouterj commented Dec 23, 2015

I've left lot's of minor comments, but 👍 for merging this one without adding more content.

@javiereguiluz
Copy link
Member Author

@wouterj thanks for the detailed review. I think I've done all the suggested changes.


* :doc:`Install it via Composer </components/using_components>`
(``symfony/browser-kit`` on `Packagist`_);
* Use the official Git repository (https://github.com/symfony/BrowserKit).
Copy link
Member

Choose a reason for hiding this comment

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

after the normalisation done recently the real URL is https://github.com/symfony/browser-kit

@yamiko-ninja
Copy link
Contributor

+1 Thanks for making the needed improvements.

@wouterj
Copy link
Member

wouterj commented Feb 6, 2016

Can someone please review & vote this PR? /cc @weaverryan @xabbuh

@xabbuh xabbuh merged commit 3f0858f into symfony:2.3 Feb 9, 2016
xabbuh added a commit that referenced this pull request Feb 9, 2016
…ninja, robert Parker, javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Add browserkit component documentation

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | -

This PR tries to finish the fantastic work made by @yamiko-ninja in #4312. Please review it so I can improve/finish it and we can merge it before year's end. Thanks!

Commits
-------

3f0858f Fixed a syntax issue
c9093a8 Implemented changes suggested by Wouter
e7056a8 Fixed a reference
5aec7c4 Minor fixes
fd35c93 Fixed a syntax issue
883c062 Finished the first version of the BrowserKit doc
03ea5a5 fix title underline
a1df783 spelling and formating
ea3fd71 Adding documentation for cookies
6b6e23a added docs on histroy
a3d158e added form submissions and moved creating a client to top
74cfecd more outlines, fixed link, added more about creating a client
dda78ba added a link snippit
94bb3bf fixed spelling
6997c4f make a basic request
b3d9eb3 added links to index and map files
f0f8a50 added links with info about clients and packagist link
1e5ca13 added in sections that I apln to fill out
9c007e9 syntax fix
645d50d fixed a few mistakes
93d7258 added introduction
xabbuh added a commit that referenced this pull request Feb 9, 2016
@xabbuh
Copy link
Member

xabbuh commented Feb 9, 2016

Thank you @yamiko-ninja and @javiereguiluz for your great work. I have merged this PR into the 2.3 branch and made some minor tweaks in 46a93be.

xabbuh added a commit that referenced this pull request Feb 9, 2016
* 2.3: (24 commits)
  removed duplicate lines
  Updated "Learn more from the Cookbook" section
  [#6072] some tweaks
  Fixed a syntax issue
  Implemented changes suggested by Wouter
  Fixed a reference
  Minor fixes
  Fixed a syntax issue
  Finished the first version of the BrowserKit doc
  fix title underline
  spelling and formating
  Adding documentation for cookies
  added docs on histroy
  added form submissions and moved creating a client to top
  more outlines, fixed link, added more about creating a client
  added a link snippit
  fixed spelling
  make a basic request
  added links to index and map files
  added links with info about clients and packagist link
  ...

Conflicts:
	components/index.rst
	components/map.rst.inc
xabbuh added a commit that referenced this pull request Feb 9, 2016
* 2.7: (26 commits)
  removed duplicate lines
  Updated "Learn more from the Cookbook" section
  [#6072] some tweaks
  [Cookbook][Console] change API doc class name
  Improvement to the apache/mod_php configuration example
  Fixed a syntax issue
  Implemented changes suggested by Wouter
  Fixed a reference
  Minor fixes
  Fixed a syntax issue
  Finished the first version of the BrowserKit doc
  fix title underline
  spelling and formating
  Adding documentation for cookies
  added docs on histroy
  added form submissions and moved creating a client to top
  more outlines, fixed link, added more about creating a client
  added a link snippit
  fixed spelling
  make a basic request
  ...
xabbuh added a commit that referenced this pull request Feb 9, 2016
* 2.8: (26 commits)
  removed duplicate lines
  Updated "Learn more from the Cookbook" section
  [#6072] some tweaks
  [Cookbook][Console] change API doc class name
  Improvement to the apache/mod_php configuration example
  Fixed a syntax issue
  Implemented changes suggested by Wouter
  Fixed a reference
  Minor fixes
  Fixed a syntax issue
  Finished the first version of the BrowserKit doc
  fix title underline
  spelling and formating
  Adding documentation for cookies
  added docs on histroy
  added form submissions and moved creating a client to top
  more outlines, fixed link, added more about creating a client
  added a link snippit
  fixed spelling
  make a basic request
  ...
xabbuh added a commit that referenced this pull request Feb 9, 2016
* 3.0: (27 commits)
  Removed all 2.x versionadded directives
  removed duplicate lines
  Updated "Learn more from the Cookbook" section
  [#6072] some tweaks
  [Cookbook][Console] change API doc class name
  Improvement to the apache/mod_php configuration example
  Fixed a syntax issue
  Implemented changes suggested by Wouter
  Fixed a reference
  Minor fixes
  Fixed a syntax issue
  Finished the first version of the BrowserKit doc
  fix title underline
  spelling and formating
  Adding documentation for cookies
  added docs on histroy
  added form submissions and moved creating a client to top
  more outlines, fixed link, added more about creating a client
  added a link snippit
  fixed spelling
  ...
@javiereguiluz javiereguiluz deleted the pr/4312 branch May 24, 2018 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants