Address PR review feedback for v1.0.0 release

- 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 <[email protected]>
Co-Authored-By: Claude <[email protected]>

Author: 3 people

Project.toml

@@ -1,6 +1,6 @@
 name = "RDatasets"
 uuid = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
-version = "0.8.0"
+version = "1.0.0"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
@@ -11,6 +11,7 @@ Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 RData = "df47a6cb-8c03-5eed-afd8-b6050d6c41da"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
+SciMLPublic = "431bcebd-1456-4ced-9d72-93c2757fff0b"
 
 [compat]
 CSV = "0.5, 0.6, 0.7, 0.8, 0.9, 0.10"
@@ -19,6 +20,7 @@ DataFrames = "0.15, 0.16, 0.17, 0.18, 0.19, 0.20, 0.21, 0.22, 1"
 FileIO = "1"
 RData = "0.5, 0.6, 0.7, 0.8, 1"
 Reexport = "0.2, 1.0"
+SciMLPublic = "1"
 julia = "1"
 
 [extras]

src/RDatasets.jl

@@ -4,10 +4,12 @@ module RDatasets
     end
 
     import Markdown
+    import SciMLPublic: @public
     using Reexport, RData, CSV, CodecZlib
     @reexport using DataFrames
 
     export dataset
+    @public description, packages
 
     global __packages = nothing
     global __datasets = nothing

src/dataset.jl

@@ -25,23 +25,24 @@ function dataset(package_name::AbstractString, dataset_name::AbstractString)
         error("Unable to locate dataset file $rdaname or $csvname")
     end
     # Finally, inject metadata into the dataframe to indicate origin:
-    DataFrames.metadata!(dataset, "RDatasets.jl", (string(package_name), string(dataset_name)))
+    metadata!(dataset, "RDatasets.jl", (string(package_name), string(dataset_name)))
     return dataset
 end
 
 
 """
     RDatasets.description(package_name::AbstractString, dataset_name::AbstractString)
-    RDatasets.description(df::DataFrame) # only call this on dataframes from RDatasets!
+    RDatasets.description(df::AbstractDataFrame; default=nothing)
 
-Returns an `RDatasetDescription` object containing the description of the dataset.
+Return an `RDatasetDescription` object containing the description of the dataset.
 
 Invoke this function in exactly the same way you would invoke `dataset` to get the dataset itself.
 
-This object prints well in the REPL, and can also be shown as markdown or HTML.
+This object prints well in the REPL, and can also be shown as Markdown or HTML.
 
-!!! note Unexported
-    This function is left deliberately unexported, since the name is pretty common.
+When passing a `DataFrame`, it must have been obtained from `RDatasets.dataset`. If the DataFrame
+does not have the required metadata, an error is thrown unless a `default` value is provided,
+in which case that value is returned instead.
 """
 function description(package_name::AbstractString, dataset_name::AbstractString)
     doc_html_file = joinpath(@__DIR__, "..", "doc", package_name, "$dataset_name.html")
@@ -53,15 +54,15 @@ function description(package_name::AbstractString, dataset_name::AbstractString)
 end
 
 # This is a convenience function to get the description of a dataset from a DataFrame.
-# Since we set metadata on the DataFrame, we can use this to get the description,
-# if it exists.
-function description(df::AbstractDataFrame)
-    if "RDatasets.jl" in DataFrames.metadatakeys(df)
-        package_name, dataset_name = DataFrames.metadata(df, "RDatasets.jl")
+# Since we set metadata on the DataFrame, we can use this to get the description.
+function description(df::AbstractDataFrame; default=nothing)
+    if "RDatasets.jl" in metadatakeys(df)
+        package_name, dataset_name = metadata(df, "RDatasets.jl")
         return description(package_name, dataset_name)
+    elseif default !== nothing
+        return default
     else
-        @warn "No metadata indicating dataset origin found.  Returning default description."
-        return RDatasetDescription("No description available.")
+        throw(ArgumentError("DataFrame does not have RDatasets.jl metadata. Use a DataFrame obtained from `RDatasets.dataset`, or provide a `default` value."))
     end
 end
 
@@ -71,9 +72,9 @@ end
 A type to hold the content of a dataset description.
 
 The main purpose of its existence is to provide a way to display the content
-differently in HTML and markdown contexts.
+differently in HTML and Markdown contexts.
 
-Invoked through [`RDatasets.description`](@ref).
+Obtained through [`RDatasets.description`](@ref).
 """
 struct RDatasetDescription
     content::String