-
-
Notifications
You must be signed in to change notification settings - Fork 209
docs: include full _copier_conf attributes list #2127
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
base: master
Are you sure you want to change the base?
Conversation
Here's the funny thing, I hadn't even noticed the introduction sentence with
until I went back and looked after I had found the |
Thanks for aspiring to improve the docs! 🙇 I agree that the render context isn't documented as well as it could be. There's only one concern I have with this addition: |
Hey @sisp, thanks for the review. If y'all are good with ensuring that the docs are just always in-sync, I'm absolutely happy to help copy over the data. Let me do a quick fix, and I'll let you give it another review 😊 |
@sisp I think this should be ready for a review now. Direct link to docs preview: https://copier--2127.org.readthedocs.build/en/2127/creating/#_copier_conf A few things that I adjusted (if you're OK with that)
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2127 +/- ##
=======================================
Coverage 98.03% 98.03%
=======================================
Files 55 55
Lines 6005 6005
=======================================
Hits 5887 5887
Misses 118 118
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@sisp Just checking if you're good with the changes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for compiling the render context attributes table so meticulously! 🙇 I have a couple of suggestions regarding clarity, consistency, and style.
Seeing this table makes it much clearer (IMO) that the render context and Worker
class attributes are not the same and not even as similar as it seemed with the previous documentation. Clarifying the render context is crucial for providing template authors with the necessary information to create good templates. Thanks for taking on this important task! 🙇
@sisp awesome review, and definitely makes things clearer! I wonder...would it make sense to group setting attributes that are just sets of booleans, and then separate some of the more "in depth" attributes into their own group? |
I think it's fine to keep all attributes in one table. There, they are sorted alphabetically and references to related settings are provided where applicable. Having a complete overview of all I've noticed that the I stumbled over one more thing: The |
0d51bf8
to
3b1f596
Compare
| `pretend` | `bool` | When `True`, produce no real rendering.<br>See the [`pretend`][] setting for related information. | | ||
| `quiet` | `bool` | When `True`, disable all output.<br>See the [`quiet`][] setting for related information. | | ||
| `sep` | `str` | The operating system-specific directory separator. | | ||
| `settings` | `pydantic.BaseModel` | Specified settings that control copier's behavior.<br>See the [`settings`][] page for related information. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sisp Thoughts on the content for this one?
Co-authored-by: Sigurd Spieckermann <[email protected]>
@@ -127,8 +127,8 @@ Attributes: | |||
| `unsafe` | `bool` | When `True`, allow usage of unsafe templates.<br>See the [`unsafe`][] setting for related information. | | |||
| `use_prereleases` | `bool` | When `True`, `vcs_ref`/`vcs_ref_hash` may refer to a prerelease version of the template.<br>See the [`use_prereleases`][] setting for related information. | | |||
| `user_defaults` | `dict[str, Any]` | Specified user defaults that may override a template's defaults during question prompts. | | |||
| `vcs_ref` | `str | None` | The VCS tag/commit of the template, `None` if the template is not VCS-tracked.<br>See the [`vcs_ref`][] setting for related information. | | |||
| `vcs_ref_hash` | `str | None` | The VCS commit hash of the template, `None` if the template is not VCS-tracked. | | |||
| `vcs_ref` | `str | None` | The VCS tag/commit of the template, `None` if the template is not VCS-tracked.<br>See the [`vcs_ref`][] setting for related information. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sisp we might have to disable autoformat
for this PR (not sure if you can). Leaving the \
in str \| None
caused the \
to actually print in the assembled docs, however removing it causes autoformat
to think that it's a column separator and add extra whitespace which then breaks the table layout 🤦♂️
No description provided.