Ex-Mente / auxi.0

GNU Lesser General Public License v3.0
8 stars 8 forks source link

Wrong function description for the stoichiometry mass_fractions function? #197

Open christoffkok opened 7 years ago

christoffkok commented 7 years ago

Background

In stoichiometry.py both the amount_fractions and the mass_fractions functions contains the same description: """Calculate the mole fractions from the specified compound masses.""" The mass_fractions function says that it returns """:returns: [mass fractions] dictionary""" though.

Purpose

The purpose of this issue is to fix an incorrect function documentation that can be confusing and misleading.

Approach

Rename the 'mole fraction' text in the mass_fractions function description to 'mass fraction'.