search

jeff1evesque / earthquake-finder

Determine largest earthquake relative to GPS coordinates using URL dataset
2 stars 1 forks source link

Adjust python docstring #229

Closed jeff1evesque closed 9 years ago

jeff1evesque commented 9 years ago

We will adjust each python script to implement the pep 257 docstring syntax.

jeff1evesque commented 9 years ago

We may decide to change the docblock at a later time. For the time being, python's help function suffices:

$ cd /var/www/html/earthquake-finder/package/
$ python
>>> import json_scraper
>>> help(json_scraper)
Help on module json_scraper:

NAME
    json_scraper

FILE
    /var/www/html/geolocation-js/package/json_scraper.py

DESCRIPTION
    ## @json_scraper.py
    #  This file makes a request to an external webpage, and returns the json
    #      response content.

FUNCTIONS
    scrape(url)
        ## scrape: scrape the content of provided url.
(END)
$ cd /var/www/html/earthquake-finder/package/
$ python
>>> import json_scraper
>>> help(json_scraper.scrape)
Help on function scrape in module json_scraper:

scrape(url)
    ## scrape: scrape the content of provided url.
(END)