55< head >
66 < meta charset ="utf-8 " />
77 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
8- < title > dataretrieval.waterdata.api — dataretrieval 0.1.dev1+gb375f19c6 documentation</ title >
8+ < title > dataretrieval.waterdata.api — dataretrieval 0.1.dev1+gd3779def0 documentation</ title >
99 < link rel ="stylesheet " type ="text/css " href ="../../../_static/pygments.css?v=b86133f3 " />
1010 < link rel ="stylesheet " type ="text/css " href ="../../../_static/css/theme.css?v=9edc463e " />
1111
1212
1313 < script src ="../../../_static/jquery.js?v=5d32c60e "> </ script >
1414 < script src ="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
15- < script src ="../../../_static/documentation_options.js?v=39c68b89 "> </ script >
15+ < script src ="../../../_static/documentation_options.js?v=e5f77573 "> </ script >
1616 < script src ="../../../_static/doctools.js?v=fd6eb6e6 "> </ script >
1717 < script src ="../../../_static/sphinx_highlight.js?v=6ffebe34 "> </ script >
1818 < script crossorigin ="anonymous " integrity ="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA= " src ="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js "> </ script >
@@ -2212,7 +2212,7 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre>
22122212
22132213< div class ="viewcode-block " id ="get_codes ">
22142214< a class ="viewcode-back " href ="../../../reference/waterdata.html#dataretrieval.waterdata.get_codes "> [docs]</ a >
2215- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> get_codes</ span > < span class ="p "> (</ span > < span class ="n "> code_service</ span > < span class ="p "> :</ span > < span class ="n "> CODE_SERVICES</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> pd</ span > < span class ="o "> .</ span > < span class ="n "> DataFrame</ span > < span class ="p "> :</ span >
2215+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> get_codes</ span > < span class ="p "> (</ span > < span class ="n "> code_service</ span > < span class ="p "> :</ span > < span class ="n "> CODE_SERVICES</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb " > tuple </ span > < span class =" p " > [ </ span > < span class =" n "> pd</ span > < span class ="o "> .</ span > < span class ="n "> DataFrame</ span > < span class ="p "> , </ span > < span class =" n " > BaseMetadata </ span > < span class =" p " > ] :</ span >
22162216< span class ="w "> </ span > < span class ="sd "> """Return codes from a Samples code service.</ span >
22172217
22182218< span class ="sd "> Parameters</ span >
@@ -2221,6 +2221,13 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre>
22212221< span class ="sd "> One of the following options: "states", "counties", "countries"</ span >
22222222< span class ="sd "> "sitetype", "samplemedia", "characteristicgroup", "characteristics",</ span >
22232223< span class ="sd "> or "observedproperty"</ span >
2224+
2225+ < span class ="sd "> Returns</ span >
2226+ < span class ="sd "> -------</ span >
2227+ < span class ="sd "> df : ``pandas.DataFrame``</ span >
2228+ < span class ="sd "> The requested code table.</ span >
2229+ < span class ="sd "> md : :obj:`dataretrieval.utils.BaseMetadata`</ span >
2230+ < span class ="sd "> Metadata for the query (URL, query time, response headers).</ span >
22242231< span class ="sd "> """</ span >
22252232 < span class ="n "> valid_code_services</ span > < span class ="o "> =</ span > < span class ="n "> get_args</ span > < span class ="p "> (</ span > < span class ="n "> CODE_SERVICES</ span > < span class ="p "> )</ span >
22262233 < span class ="k "> if</ span > < span class ="n "> code_service</ span > < span class ="ow "> not</ span > < span class ="ow "> in</ span > < span class ="n "> valid_code_services</ span > < span class ="p "> :</ span >
@@ -2240,7 +2247,7 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre>
22402247
22412248 < span class ="n "> df</ span > < span class ="o "> =</ span > < span class ="n "> pd</ span > < span class ="o "> .</ span > < span class ="n "> DataFrame</ span > < span class ="p "> (</ span > < span class ="n "> data_list</ span > < span class ="p "> )</ span >
22422249
2243- < span class ="k "> return</ span > < span class ="n "> df</ span > </ div >
2250+ < span class ="k "> return</ span > < span class ="n "> df</ span > < span class =" p " > , </ span > < span class =" n " > BaseMetadata </ span > < span class =" p " > ( </ span > < span class =" n " > response </ span > < span class =" p " > ) </ span > < /div >
22442251
22452252
22462253
0 commit comments