djsilva99 / heatrapy

Python library for simulating heat transfer processes
https://djsilva99.github.io/heatrapy
MIT License
72 stars 14 forks source link

docs: fix documentation for Q0 and Q #49

Closed djsilva99 closed 6 days ago

djsilva99 commented 6 days ago

What

The docstrings mentioning the Q and Q0 parameters are incorrect. This PR fixes it.

Why

Since the documentation is based on the docstrings it is important to have it sound.

How

Documentation

This PR fixes the issue #16

codecov[bot] commented 6 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 70.57%. Comparing base (f5a2ff5) to head (5060e3c). Report is 1 commits behind head on develop.

@@           Coverage Diff            @@
##           develop      #49   +/-   ##
========================================
  Coverage    70.57%   70.57%           
========================================
  Files           21       21           
  Lines         2328     2328           
========================================
  Hits          1643     1643           
  Misses         685      685           
Files with missing lines Coverage Δ
heatrapy/dimension_1/objects/object.py 79.51% <ø> (ø)
heatrapy/dimension_2/objects/object.py 57.48% <ø> (ø)
heatrapy/dimension_2/objects/single.py 81.73% <ø> (ø)

🚨 Try these New Features: