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

Refactor the additional request docs #197

Merged
merged 9 commits into from
Jan 31, 2024

Conversation

Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented Jan 25, 2024

Most of the existing content felt too reference-like to me, and we already have reference documentation, but I might have gone too far with the removing of content, so please feel more than free to suggest bringing back stuff or featuring additional stuff.

I also moved the input validation page as a section of inputs, because it felt right there and it made sense to me that the content about input validation, mentioned in the additional requests page in the context of retries, was before the additional requests content in reading order.

@Gallaecio Gallaecio requested review from kmike, wRAR and BurnzZ January 25, 2024 14:14
Copy link

codecov bot commented Jan 25, 2024

Codecov Report

Merging #197 (79eb00a) into master (285329e) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #197   +/-   ##
=======================================
  Coverage   98.46%   98.47%           
=======================================
  Files          31       31           
  Lines        1437     1438    +1     
=======================================
+ Hits         1415     1416    +1     
  Misses         22       22           
Files Coverage Δ
web_poet/exceptions/http.py 100.00% <100.00%> (ø)

Comment on lines -143 to +146
In the previous :ref:`exception-handling` section, we can see how Page Object
developers could use the exception classes built inside **web-poet** to handle
various ways additional requests MAY fail. In this section, we'll see the
rationale and ways the framework MUST be able to do that.
Page Object developers could use the exception classes built inside
**web-poet** to handle various ways additional requests MAY fail. In this
section, we'll see the rationale and ways the framework MUST be able to do
that.
Copy link
Member Author

Choose a reason for hiding this comment

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

The change here is the removal of the first part, In the previous :ref:`exception-handling` section, we can see how, due to the removal of the referred content.

docs/page-objects/inputs.rst Outdated Show resolved Hide resolved
Co-authored-by: Mikhail Korobov <kmike84@gmail.com>
@Gallaecio Gallaecio merged commit d007f91 into scrapinghub:master Jan 31, 2024
16 checks passed
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.

2 participants