Merge branch 'update/docstring_documentation' into 'master'

Update concentration docstring

See merge request cara/cara!269
This commit is contained in:
Philip Elson 2021-10-06 11:58:37 +02:00
commit 86288a0ec4

View file

@ -873,7 +873,7 @@ class ConcentrationModel:
@method_cache
def normed_integrated_concentration(self, start: float, stop: float) -> _VectorisedFloat:
"""
Get the integrated concentration dose between the times start and stop,
Get the integrated concentration of viruses in the air between the times start and stop,
normalized by the emission rate.
"""
if stop <= self._first_presence_time():
@ -902,7 +902,7 @@ class ConcentrationModel:
def integrated_concentration(self, start: float, stop: float) -> _VectorisedFloat:
"""
Get the integrated concentration dose between the times start and stop.
Get the integrated concentration of viruses in the air between the times start and stop.
"""
return (self.normed_integrated_concentration(start, stop) *
self.infected.emission_rate_when_present())