docs: 📝 add examples to user facing functions #982
Merged
Conversation
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
Based on the work by @martonvago in 498e1b9.
… to `dict` internally
signekb
commented
Jan 21, 2025
| # Set global path for the example | ||
| os.environ["SPROUT_GLOBAL"] = ".storage/" | ||
|
|
||
| # sp.path_package_database(package_id=1) |
There was a problem hiding this comment.
Commented out bc there is no package database in the current setup. This function will soon be removed altogether #980
signekb
commented
Jan 21, 2025
Comment on lines
36
to
57
| ```{python} | ||
| #| output: false | ||
| #| echo: false | ||
| import os | ||
|
|
||
| import seedcase_sprout.core as sp | ||
| from seedcase_sprout.core.write_json import write_json | ||
|
|
||
| # Set global path for the example | ||
| os.environ["SPROUT_GLOBAL"] = ".storage/" | ||
|
|
||
| edited_properties = sp.edit_package_properties( | ||
| path=sp.path_package_properties(package_id=1), | ||
| properties=sp.PackageProperties( | ||
| name="new-package-name", | ||
| title="New Package Title", | ||
| description="This is a package description", | ||
| ), | ||
| ).compact_dict | ||
|
|
||
| write_json(edited_properties, path=sp.path_package_properties(package_id=1)) | ||
| ``` |
There was a problem hiding this comment.
Had to add this bc write_resource_properties() would fail otherwise bc the existing properties/data-package.json are missing required fields (name, description, title)
But it won't be showed (output and echo is false)
signekb
commented
Jan 21, 2025
Comment on lines
46
to
51
| Examples: | ||
| ```{python} | ||
| #| output: false | ||
| #| echo: false | ||
| f = open(".storage/packages/1/resources/1/data.parquet", "x") | ||
| ``` |
There was a problem hiding this comment.
Added this so there was a data file to get the path for.
signekb
commented
Jan 21, 2025
Comment on lines
111
to
115
| ```{python} | ||
| #| echo: false | ||
| f = open(".storage/packages/1/resources/1/raw/file1.csv", "x") | ||
| f = open(".storage/packages/1/resources/1/raw/file2.csv", "x") | ||
| ``` |
There was a problem hiding this comment.
Added these so the example wouldn't just return an empty list.
So the examples will run correctly. If `create_resource_properties` is run before `create_resource_structure` the example will fail bc the resource structure doesn't exist yet.
There's no output of this code chunk, so it's not needed.
signekb
changed the title
By moving `write_resource_properties` down.
Base automatically changed from
refactor/use-properties-classes-in-userfacing-functions
to
main
January 22, 2025 08:45
lwjohnst86
requested changes
Jan 22, 2025
signekb
commented
Jan 24, 2025
Comment on lines
+69
to
+80
| # TODO: Add data to resource | ||
| # sp.write_resource_data_to_raw( | ||
| # package_id=1, | ||
| # resource_id=1, | ||
| # data="path/to/data.csv") | ||
|
|
||
| # sp.write_resource_parquet( | ||
| # raw_files=sp.path_resource_raw_files(package_id=1, resource_id=1), | ||
| # path=sp.path_resource_data(package_id=1, resource_id=1)) | ||
|
|
||
| # Get the path to the resource data | ||
| # sp.path_resource_data(package_id=1, resource_id=1) |
There was a problem hiding this comment.
Some examples, such as this one, requires functionality that doesn't exist yet, so I have commented it out and added a TODO item.
signekb
commented
Jan 24, 2025
Comment on lines
+51
to
72
| # TODO: Write package properties that passes checks | ||
| # Write package properties | ||
| # sp.write_package_properties( | ||
| # path=temp_dir / "1" / "datapackage.json", | ||
| # package_properties=sp.PackageProperties( | ||
| # title="New Package Title", | ||
| # name="new-package-name", | ||
| # description="New Description", | ||
| # ), | ||
|
|
||
| # Write resource properties | ||
| # sp.write_resource_properties( | ||
| # path=temp_dir / "1" / "datapackage.json", | ||
| # resource_properties=sp.ResourceProperties( | ||
| # name="new-resource-name", | ||
| # title="New resource name", | ||
| # description="This is a new resource", | ||
| # path="data.parquet", | ||
| # ), | ||
| # ) | ||
| ``` | ||
| """ |
There was a problem hiding this comment.
Same here. Currently, we can't write resource properties on a newly created package bc the (package) properties are missing required fields.
lwjohnst86
added a commit
that referenced
this pull request
Jan 24, 2025
## Description This PR adds docstrings to the modules with multiple/many functions/classes. Note that this is stacked on #982 <!-- Select quick/in-depth as necessary --> This PR needs an in-depth review. ## Checklist - [X] Updated documentation - [X] Ran `just run-all` --------- Co-authored-by: Luke W. Johnston <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds examples in the docstrings of user facing functions.
Closes #951
This PR needs an in-depth review.
Checklist
just run-all