This is Michela's Pull Request - add documentation to IPUMS.jl #34
Conversation
- added code example - adjusted variable descriptions
- added code example - add variable descriptions - added references
- add Examples -add description -add References -add Returns
-add description -add examples - add return
add description add return add ref add examples
add description add example add reference add return
add description add reference add examples add arguments
add refernce add description add arguments add examples
add ref add description add arguments add examples
add description add reference add examples add return
add descruption add reference add examples add return add description
add returns add examples add ref add description
add description,examples,ref,return. To be checked
added code example to DataExtract. added reference to ChatGPT.
- change definition -suppress output
-keyword argument examples in argument fixed description and return missing example
definition and return changed missing example and argument definition
ok description and return missing example
ok description,examples,return ad arguments
space added
description and return changed
…riesTableFull files.
…d TimeSeriesTableFull files." This reverts commit b0f2372.
…riesTableFullTimeSeriesInner functions.
…e, DatasetFullGeogLevelsInner, TimeSeriesTableSimple.
…tFullBreakdownsBreakdownValuesInner, and DatasetSimple.
…iesTableFull, and TimeSeriesTableFulltimeSeriesInner.
…oadLinks, DataExtractPost, DataExtractPostResponse, and Error.
There was a problem hiding this comment.
Hey @MichelaRocchetti and @00krishna ,
This looks great! I only have one question: what are all the (Optional) statements for by so many arguments? My understanding is that if you don't provide any of these arguments with the (Optional) argument, then it would return a malformed statement back from the API endpoint.
Otherwise, if you can help me understand that, that is my only question.
Thanks!
~ tcp 🌳
|
@TheCedarPrince Yeah, I think that all of the arguments are not needed every time for the api to work. I actually took the code examples from the Mechanically, the optional arguments are implemented as keyword arguments. So these keyword arguments have default values, like We are still in the process of testing all of these specific requests to make sure that they work. This is what @MichelaRocchetti was working on before she went on vacation. But we will continue with that to make sure that all requests check out. Let me know if you have any additional questions. |
This is Michela's original PR. But since her branch is located on her private repo, I did not have permissions to make changes there. Hence I had to create a new PR based upon her work. These are just some additional clean up and edits based upon @TheCedarPrince 's original comments.