Skip to content

Inconsistent labeling of Humidity Ratio in documentation #91

@akiss-ic

Description

@akiss-ic

Describe the bug
The definition of Humidity Ratio is inconsistent between different function argument descriptions.

E.g. for GetTDryBulbFromEnthalpyAndHumRatio it is defined as

HumRatio : Humidity ratio in lb_H₂O lb_Air⁻¹ [IP] or kg_H₂O kg_Air⁻¹ [SI]

but for GetSpecificHumFromHumRatio it is defined as

HumRatio : Humidity ratio in lb_H₂O lb_Dry_Air⁻¹ [IP] or kg_H₂O kg_Dry_Air⁻¹ [SI]

where the latter is accurate and more descriptive but the former is more extensively used in the psychrolib function argument documentation. Given that humidity ratio vs specific humidity tends to be a source of confusion, I suggest the definition of HumRatio in the documentation should be consistently specified to the second one above.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions