docs: Minor changes (#1288)

- [x] very minor change in the README - [x] hide the deprecated section in the API as it is now empty
probabl-ai · Feb 5, 2025 · 0843c81 · 0843c81
1 parent 7b15901
commit 0843c81
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -96,19 +96,19 @@ You can find information on the latest version [here](https://anaconda.org/conda
 
 1. Store your results for safe-keeping.
     ```python
-    # create and load a skore project
+    # Create and load a skore project
     import skore
     my_project = skore.Project("my_project")
     ```
 
     ```python
-    # store your results
+    # Store your results
     my_project.put("df_cv_report_metrics", df_cv_report_metrics)
     my_project.put("roc_plot", roc_plot)
     ```
 
     ```python
-    # get your results
+    # Get your results
     df_get = my_project.put("df_cv_report_metrics")
     ```
 

diff --git a/sphinx/api.rst b/sphinx/api.rst
@@ -145,12 +145,12 @@ get the common performance metric representations.
     CrossValidationReport.metrics.plot.prediction_error
     CrossValidationReport.metrics.plot.roc
 
-Deprecated
-----------
+.. Deprecated
+.. ----------
 
-These functions and classes are deprecated.
+.. These functions and classes are deprecated.
 
-.. autosummary::
-    :toctree: generated/
-    :template: base.rst
-    :caption: Deprecated
+.. .. autosummary::
+..     :toctree: generated/
+..     :template: base.rst
+..     :caption: Deprecated