Skip to content

Commit 4c240d7

Browse files
authored
Merge pull request #6296 from tekktrik/doc/add-log-documentation
Add documentation for math.log()
2 parents da21807 + 211d42f commit 4c240d7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

shared-bindings/math/__init__.c

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ STATIC NORETURN void math_error(void) {
157157
//| """Return ``x * (2**exp)``."""
158158
//| ...
159159
//|
160+
//| def log(x: float, base: float = e) -> float:
161+
//| """Return the logarithm of x to the given base. If base is not specified,
162+
//| returns the natural logarithm (base e) of x"""
163+
//| ...
164+
//|
160165
//| def modf(x: float) -> Tuple[float, float]:
161166
//| """Return a tuple of two floats, being the fractional and integral parts of
162167
//| ``x``. Both return values have the same sign as ``x``."""

0 commit comments

Comments
 (0)