Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

Bugfixes + fix errors in docstrings #116

Open
wants to merge 2 commits into
base: week06
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
week06/average-squares-example/average_squares/__pycache__/*
week06/average-squares-example/.DS_Store
week06/average-squares-example/docs/.DS_Store
8 changes: 4 additions & 4 deletions week06/average-squares-example/average_squares/squares.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def average_of_squares(list_of_numbers, list_of_weights=None):
>>> average_of_squares([1, 2, 4])
7.0
>>> average_of_squares([2, 4], [1, 0.5])
6.0
8.0
>>> average_of_squares([1, 2, 4], [1, 0.5])
Traceback (most recent call last):
AssertionError: weights and numbers must have same length
Expand All @@ -29,7 +29,7 @@ def average_of_squares(list_of_numbers, list_of_weights=None):
for number, weight
in zip(list_of_numbers, effective_weights)
]
return sum(squares)
return sum(squares) / sum(effective_weights)


def convert_numbers(list_of_strings):
Expand All @@ -38,7 +38,7 @@ def convert_numbers(list_of_strings):
Example:
--------
>>> convert_numbers(["4", " 8 ", "15 16", " 23 42 "])
[4, 8, 15, 16]
[4.0, 8.0, 15.0, 16.0, 23.0, 42.0]

"""
all_numbers = []
Expand All @@ -59,4 +59,4 @@ def convert_numbers(list_of_strings):

result = average_of_squares(numbers, weights)

print(result)
print(result)
20 changes: 20 additions & 0 deletions week06/average-squares-example/docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
4 changes: 4 additions & 0 deletions week06/average-squares-example/docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7f67e81edaa990851921a41b9755f78f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Average Squares Documentation
=============================

.. automodule:: squares
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Average Squares Documentation
=============================
hahahahah
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. Average Squares documentation master file, created by
sphinx-quickstart on Tue Nov 17 21:25:21 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Average Squares's documentation!
===========================================

What happens when I do this?

.. toctree::
:maxdepth: 2
:caption: Contents:

Link to average-squares-docs <content/average-squares-docs>





Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Loading