chore: attempt to be more informative for missing attributes #1702
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1702 +/- ##
==========================================
+ Coverage 92.01% 92.02% +0.01%
==========================================
Files 75 75
Lines 4670 4677 +7
==========================================
+ Hits 4297 4304 +7
Misses 373 373
Flags with carried forward coverage won't be shown. Click here to find out more.
|
dafe0be to
f8dde55
Compare
|
This will also close #1138. |
f8dde55 to
b7cd66b
Compare
There was a problem hiding this comment.
Thanks @JohnVillalovos, just a few small notes from me.
I was thinking something similar for missing methods in e.g. Issue vs ProjectIssue to guide users towards creating the right objects or even give a make_editable() method for those to convert them. So I really like it and would maybe build on this later as well. I think there might also be a few other cases where this could be extended later, such as after running save/update and so on.
Thanks for the review! Will work on updating the PR. I like the idea of catching the common issues that users of the library encounter and trying to point them to how to fix it so they file less issues 😊 |
b7cd66b to
f881a01
Compare
644ef29 to
6c5fe03
Compare
6c5fe03 to
760beb4
Compare
A commonly reported issue from users on Gitter is that they get an AttributeError for an attribute that should be present. This is often caused due to the fact that they used the `list()` method to retrieve the object and objects retrieved this way often only have a subset of the full data. Add more details in the AttributeError message that explains the situation to users. This will hopefully allow them to resolve the issue. Update the FAQ in the docs to add a section discussing the issue. Closes #1138
760beb4 to
1839c9e
Compare
A commonly reported issue from users on Gitter is that they get an
AttributeError for an attribute that should be present. This is often
caused due to the fact that they used the
list()method to retrievethe object and objects retrieved this way often only have a subset of
the full data.
Add more details in the AttributeError message that explains the
situation to users. This will hopefully allow them to resolve the
issue.
Closes #1138