Refactor and polish docs #274
Closed
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
|
(maybe it’s also time to get rid of the testimonials, at least in the docs. they take a lot of space) |
Codecov Report
@@ Coverage Diff @@
## refactor-class-creation #274 +/- ##
======================================================
Coverage 100% 100%
======================================================
Files 9 9
Lines 660 660
Branches 138 138
======================================================
Hits 660 660
Continue to review full report at Codecov.
|
hynek
force-pushed
the
narrative-docs
branch
2 times, most recently
from
47d5320
to
a51ae31
Compare
Instead of adding and possibly later deleting attributes, the class creation is delegated into a cleaner building pattern.
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.
attrshas grown out of its doc structure long time ago and it’s time to acknowledge that we need narrative docs. Docs that maybe will prevent people from opening the daily issue about underscore prefix-handling in__init__and docs that give us better space to explain concepts in general.This isn’t those docs yet. Instead it makes the index more beginner friendly and lays out the space for narrative docs: the
Day-to-Day Usagesection (better names welcome).It’s against #272 because I hope that’s gonna get merged soon (wink wink).
To give you an idea, how the new layout looks like, I’ve activated it in readthedocs for your viewing pleasure: http://www.attrs.org/en/narrative-docs/
Please let me know what ya’ll think!