emma/synthale
1
0
Fork 0
mirror of https://github.com/shouptech/synthale.git synced 2026-02-03 15:39:45 +00:00
Code Issues Releases Wiki Activity

updated docstrings

Browse source
This commit is contained in:
Emma 2019-01-01 17:27:47 -07:00
parent 89ab2b7449
commit 9c26e81bd1
3 changed files with 33 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/synthale/__init__.py Normal file
View file

@ -0,0 +1,16 @@
"""Synthale package."""
# Copyright (C) 2019 Mike Shoup
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

64
src/synthale/convert.py
View file

@ -3,6 +3,14 @@
Input units for volumes is liters. Input units for mass is kilograms. These
units are the defaults used in the BeerXML format, and as a result, in
`pybeerxml`.
Functions in this module accept a format_spec parameter. The format_spec
parameter is a string conforming to the Python "Format Specification Mini
Language".
See `format_spec`_ documentation.
.. _format_spec: https://docs.python.org/3/library/string.html#format-specification-mini-language # noqa
"""
# Copyright (C) 2019 Mike Shoup
@ -22,80 +30,40 @@ units are the defaults used in the BeerXML format, and as a result, in
def liters(liters, format_spec=''):
"""Return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Return a string with the unit appended."""
return ('{:' + format_spec + '} L').format(liters)
def gallons(liters, format_spec=''):
"""Convert liters to gallons and return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Convert liters to gallons and return a string with the unit appended."""
return ('{:' + format_spec + '} gal').format(liters * 0.264178)
def kilograms(kilograms, format_spec=''):
"""Return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Return a string with the unit appended."""
return ('{:' + format_spec + '} kg').format(kilograms)
def grams(kilograms, format_spec=''):
"""Convert kilograms to grams and return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Convert kilograms to grams, return a string with the unit appended."""
return ('{:' + format_spec + '} g').format(kilograms * 1000.0)
def ounces(kilograms, format_spec=''):
"""Convert kilograms to ounces and return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Convert kilograms to ounces, return a string with the unit appended."""
return ('{:' + format_spec + '} oz').format(kilograms * 35.273962)
def pounds(kilograms, format_spec=''):
"""Convert kilograms to pounds and return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Convert kilograms to pounds, return a string with the unit appended."""
return ('{:' + format_spec + '} lb').format(kilograms * 2.204623)
def celsius(celsius, format_spec=''):
"""Return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Return a string with the unit appended."""
return ('{:' + format_spec + '} °C').format(celsius)
def fahrenheit(celsius, format_spec=''):
"""Convert celsius to fahrenheit and return a string with the unit appended.
See the `Format Specification Mini-Language
<https://docs.python.org/3/library/string.html#format-specification-mini-language>_`
for how to write `format_spec`.
"""
"""Convert celsius to fahrenheit, return a string with unit appended."""
return ('{:' + format_spec + '} °F').format(celsius * 1.8 + 32)

2
src/synthale/markdown.py
View file

@ -49,7 +49,7 @@ def strong(text):
def table(headers, rows):
"""Generate a table.
'headers' is a list/tuple of header cells. 'rows' is a list of lists
`headers` is a list/tuple of header cells. `rows` is a list of lists
containing each cell. If any row has more cells than there are headers, the
extra cells are silently dropped.