Created
June 11, 2020 11:25
-
-
Save bdnf/13dd45744e63b7b7c12039c6bd648f69 to your computer and use it in GitHub Desktop.
An example of proper docstrings for Python
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
class Pants: | |
"""The Pants class represents an article of clothing sold in a store | |
""" | |
def __init__(self, color, waist_size, length, price): | |
"""Method for initializing a Pants object | |
Args: | |
color (str) | |
waist_size (int) | |
length (int) | |
price (float) | |
Attributes: | |
color (str): color of a pants object | |
waist_size (str): waist size of a pants object | |
length (str): length of a pants object | |
price (float): price of a pants object | |
""" | |
self.color = color | |
self.waist_size = waist_size | |
self.length = length | |
self.price = price | |
def change_price(self, new_price): | |
"""The change_price method changes the price attribute of a pants object | |
Args: | |
new_price (float): the new price of the pants object | |
Returns: None | |
""" | |
self.price = new_price | |
def discount(self, percentage): | |
"""The discount method outputs a discounted price of a pants object | |
Args: | |
percentage (float): a decimal representing the amount to discount | |
Returns: | |
float: the discounted price | |
""" | |
return self.price * (1 - percentage) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment