Prepare for a new version#145
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #145 +/- ##
===========================================
- Coverage 83.33% 36.61% -46.72%
===========================================
Files 3 4 +1
Lines 24 71 +47
===========================================
+ Hits 20 26 +6
- Misses 4 45 +41 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The changes look to make sense. I left one comment. I am not a maintainer of this package (and I do not know its internals). Maybe @nalimilan knows who has appropriate knowledge of the internals to approve it. Thank you for working on it. |
|
Appreciate everyone's work on this package. |
nalimilan
left a comment
nalimilan
left a comment
There was a problem hiding this comment.
Sorry for the delay! I have a few comments.
| RDatasets.description(iris) # only use this on DataFrames returned from `dataset`! | ||
| ``` |
There was a problem hiding this comment.
| RDatasets.description(iris) # only use this on DataFrames returned from `dataset`! | |
| ``` | |
| RDatasets.description(iris) | |
| ``` | |
| Only use the latter on data frames returned from `dataset`. | |
|
asinghvi17 Sorry to ping (and thanks for the work here) - any progress here? |
|
I've tagged a minimal maintenance release versioned 0.8.0, but it would be good to get this one finalized for a 1.0 release. |
|
Thanks for the ping here! I had lost track of this a bit - will address the comments. |
Co-authored-by: jbrea <jbrea@users.noreply.github.com>
* Streamline adding a new dataset * Add instructions to README for adding a new dataset * Add scripts to update the dataset metadata * Add update_doc method to only add a single dataset * Add HTML documentation generation to update_doc * Change update_doc to correctly round trip quotes in the metadata CSV * Sort datasets CSV * Allow datasets with a .RData extension as well as .rda --------- Co-authored-by: Frankie Robertson <frankie@robertson.name>
This allows them to be displayed in a much better way in the REPL.
- Fix docstring conventions: "Returns" -> "Return", "Invoked" -> "Obtained" - Capitalize "Markdown" consistently in documentation - Move DataFrame constraint info from signature comment into docstring body - Remove unnecessary DataFrames. prefixes (use metadata!, metadatakeys, metadata directly) - Replace unexported note with @public declaration for description and packages - Add SciMLPublic.jl dependency for @public macro - Throw error instead of warning when DataFrame lacks RDatasets metadata - Add `default` keyword argument to description(df) for graceful fallback - Bump version to 1.0.0 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Milan Bouchet-Valat <nalimilan@club.fr> Co-Authored-By: Claude <noreply@anthropic.com>
asinghvi17
force-pushed
the
as/new_version
branch
from
eaa1416 to
0f6fbce
Compare
|
@asinghvi17 Are you ready for @nalimilan to take another look? |
|
Not quite yet, still a couple things to fix up. Give me a couple days? Edit: sorry, that came out a bit more aggressive than I intended :D - meant to check back in a couple days where I should have something |
|
Oops I have merged #135 but I forgot it was included in this one. I hope it won't create too many conflicts. |
|
| Edit: sorry, that came out a bit more aggressive than I intended :D - meant to check back in a couple days where I should have something No no, didn't interpret it that way at all. Appreciate the work here, thank you! You are ready when you're ready. |
|
@asinghvi17 How's this coming along? Are you still able to finish this? |
7 participants
This is a combined PR for a bunch of different PRs that are currently up. Below is a summary of changes:
dataset, indicating that the dataframe was generated by RDatasets.jl and mentioning its package and dataset name as a Tuple. This is essentially a callDataFrames.metadata!(df, "RDatasets.jl" => (package_name, dataset_name)).descriptionfunction to RDatasets, make it readable in the REPLPRs #135 from @frankier and #124 from @jbrea are incorporated here.