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

ENH: add doc decorator #539

Merged
merged 2 commits into from
Sep 23, 2023
Merged

ENH: add doc decorator #539

merged 2 commits into from
Sep 23, 2023

Conversation

bifbof
Copy link
Collaborator

@bifbof bifbof commented Sep 22, 2023

Moved the introduction of @doc out of #538 to make the change more reviewable.
@doc is a decorator to take docstring templates, concatenate them and perform string substitution on them.

@bifbof bifbof changed the title ENH: add doc decorator changing docstrings ENH: add doc decorator Sep 22, 2023
@codecov
Copy link

codecov bot commented Sep 22, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.06% 🎉

Comparison is base (9dd980e) 93.35% compared to head (74e2a3c) 93.41%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #539      +/-   ##
==========================================
+ Coverage   93.35%   93.41%   +0.06%     
==========================================
  Files          32       32              
  Lines        2136     2156      +20     
  Branches      410      429      +19     
==========================================
+ Hits         1994     2014      +20     
  Misses        129      129              
  Partials       13       13              
Files Changed Coverage Δ
trackintel/io/postgis.py 96.07% <100.00%> (ø)
trackintel/model/util.py 100.00% <100.00%> (ø)

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

Copy link
Member

@hongyeehh hongyeehh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for introducing the new doc() function. I am just still a bit confused about the import problem.

trackintel/model/util.py Show resolved Hide resolved
trackintel/io/postgis.py Show resolved Hide resolved
@hongyeehh hongyeehh merged commit 663db9c into mie-lab:master Sep 23, 2023
7 checks passed
@bifbof bifbof deleted the add_doc_decorator branch September 23, 2023 21:54
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.

2 participants