Refactor the field docs #193
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #193 +/- ##
==========================================
+ Coverage 98.44% 98.46% +0.02%
==========================================
Files 30 31 +1
Lines 1414 1437 +23
==========================================
+ Hits 1392 1415 +23
Misses 22 22 |
kmike
reviewed
Dec 19, 2023
BurnzZ
reviewed
Dec 22, 2023
wRAR
approved these changes
Dec 26, 2023
BurnzZ
approved these changes
Dec 27, 2023
kmike
reviewed
Jan 18, 2024
| @@ -24,11 +25,60 @@ class. For example: | |||
| Because itemadapter_ allows implementing support for arbitrary classes, | |||
| any kind of Python object can potentially work as an item. | |||
|
|
|||
| Defining the item class of a page object class | |||
| ============================================== | |||
There was a problem hiding this comment.
👍 for moving/adding these docs here
kmike
reviewed
Jan 18, 2024
docs/page-objects/fields.rst
Outdated
| A field is a read-only property in a :ref:`page object class <page-objects>` | ||
| that is decorated with :meth:`@field <web_poet.fields.field>`, is named after a | ||
| key of the :ref:`item <items>` that the page object class returns, and returns | ||
| the value for that item key based on :ref:`inputs <inputs>`. |
There was a problem hiding this comment.
I found this paragraph a bit hard to read. I guess it starts with "..a read-only property in a page-objects
that is decorated with..", where it's not immediately clear if a property is decorated, or a page object is decorated, or if you should use Python's @property (which must be read-only), and decorate it with @field.
Would it be possible to re-phrase it? Using bullet points instead of many commas may also help.
kmike
reviewed
Jan 18, 2024
|
Looks good overall! |
Merged
|
Thanks @Gallaecio! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.