Exceptions in separate section #170
Conversation
Codecov Report
@@ Coverage Diff @@
## master #170 +/- ##
===========================================
+ Coverage 98.25% 100.00% +1.74%
===========================================
Files 27 1 -26
Lines 6647 353 -6294
Branches 44 44
===========================================
- Hits 6531 353 -6178
+ Misses 116 0 -116 Continue to review full report at Codecov.
|
| @@ -139,6 +142,16 @@ <h2><a href="#data">Data</a></h2> | |||
| </dl> | |||
| </section> | |||
| {% endif %} | |||
| {% if page.exceptions %} | |||
There was a problem hiding this comment.
I've created a separate variable for exceptions. The alternatives of has_exceptions/has_classes variables or manual checks in templates look worse to me.
There was a problem hiding this comment.
I'd actually keep them together in page.classes and branch in the template. That way people have more flexibility, either have them separate or put them sorted together with classes into a single "Classes" section in a modified template if they want.
There was a problem hiding this comment.
I like this, except that I'd put exceptions together with classes into page.classes and then let people branch in the template (or not).
Assuming you wouldn't have time to get back to this project in the near future, I'll make the change when I get to merging this.
| @@ -139,6 +142,16 @@ <h2><a href="#data">Data</a></h2> | |||
| </dl> | |||
| </section> | |||
| {% endif %} | |||
| {% if page.exceptions %} | |||
There was a problem hiding this comment.
I'd actually keep them together in page.classes and branch in the template. That way people have more flexibility, either have them separate or put them sorted together with classes into a single "Classes" section in a modified template if they want.
|
Actually I don't know what to do with this. Attempted to merge this with the above-suggested modification, but halfway through I realized the distinction is done in module/class pages, but search shows both exceptions and classes as still classes, and then I'm not really sure if such distinction is actually that much important to be hardcoded this way, or whether this whole thing shouldn't be completely optional. And then there's dataclasses and generators and slots and shouldn't these also have a distinct treatment? Where to draw the line? I get that right now the tool doesn't properly parse inheritance hierarchies and as such it's rather hard to see what's an exception and what not. However adding an |
|
I don't have an answer for that. I did a minimal change that worked for my use case. I wanted separation of exceptions because of their lesser importance than regular classes in my specific library. It feels like moving branching to templates is the right direction. I think some new convenient properties/functions would help to avoid template code repetition and simplify it. |
This PR splits
Classessection in two:ClassesandExceptions.