Skip to content
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

Better doc by explicitly using __qualname__ instead of __repr__() #238

Merged
merged 1 commit into from
Feb 28, 2024

Conversation

leuchtum
Copy link
Contributor

Description

By explicitly using the __qualname__ string of an object (introduced in PEP 3155), the documentation does not include the <...> brackets with the memory address.

Screenshots

HereVariable.assign_attrs as an example, but more methods are affected.

Screenshot documentation BEFORE changes

Bildschirmfoto 2024-02-27 um 22 48 29

Screenshot documentation AFTER changes

Bildschirmfoto 2024-02-27 um 22 48 14

Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.13%. Comparing base (497061a) to head (9b8bf1c).
Report is 14 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #238      +/-   ##
==========================================
+ Coverage   88.07%   88.13%   +0.06%     
==========================================
  Files          15       15              
  Lines        3413     3440      +27     
  Branches      789      793       +4     
==========================================
+ Hits         3006     3032      +26     
- Misses        296      297       +1     
  Partials      111      111              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@FabianHofmann
Copy link
Collaborator

great, thanks @leuchtum

@FabianHofmann FabianHofmann merged commit dd87738 into PyPSA:master Feb 28, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants