doc v2.0.0

loco-philippe · May 6, 2024 · 7a50ea6 · 7a50ea6
1 parent 00cde78
commit 7a50ea6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 13 deletions.
diff --git a/example/README.md b/example/README.md
@@ -2,7 +2,7 @@
 
 Five Notebooks are available:
 
-- [multidimensional example](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_analysis.ipynb) presents the multidimensional interfaces
+- [multidimensional example](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_multidimensional.ipynb) presents the multidimensional interfaces
 - [integrity](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_analysis.ipynb) explains how identify integrity errors in a DataFrame
 - [json-pandas](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_json_pandas.ipynb) presents limitations of existing json-pandas interface
 - [ntv-pandas](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_ntv_pandas.ipynb) presents the JSON interface

diff --git a/ntv_pandas/__init__.py b/ntv_pandas/__init__.py
@@ -22,16 +22,12 @@
 - `ntv-pandas.ntv_pandas.accessors` :
     
     - `ntv-pandas.ntv_pandas.accessors.NpdSeriesAccessor`
-    - `ntv-pandas.ntv_pandas.accessors.NpdDataFrameAccessor`
-    
-    
+    - `ntv-pandas.ntv_pandas.accessors.NpdDataFrameAccessor`  
 """
-#from pathlib import Path
 from ntv_pandas.pandas_ntv_connector import DataFrameConnec, SeriesConnec, read_json
 from ntv_pandas.pandas_ntv_connector import to_json, as_def_type, equals, to_analysis
 from ntv_pandas.pandas_ntv_connector import from_xarray, from_scipp
 import ntv_pandas.accessors
-#import ntv_pandas.pandas_ntv_connector
 
 #path = Path(ntv_pandas.pandas_ntv_connector.__file__).parent
 

diff --git a/ntv_pandas/accessors.py b/ntv_pandas/accessors.py
@@ -67,10 +67,10 @@ def to_xarray(self, **kwargs):
 
         *Parameters*
 
-        - dims: list of string (default None) - order of dimensions to apply
-        - **dataset** : Boolean (default True) - if False and a single data_var,
+        - **dims**: list of string (default None) - order of dimensions to apply
+        - **dataset**: Boolean (default True) - if False and a single data_var,
         return a sc.DataArray
-        - **datagroup** : Boolean (default True) - if True, return a sc.DataGroup
+        - **datagroup**: Boolean (default True) - if True, return a sc.DataGroup
         which contains the sc.DataArray/sc.Dataset and the other data else only
         sc.DataArray/sc.Dataset"""
         return Xdataset.from_dataframe(self._obj, **kwargs).to_xarray(**kwargs)
@@ -81,12 +81,12 @@ def to_scipp(self, **kwargs):
 
         *Parameters*
 
-        - dims: list of string (default None) - order of dimensions to apply
-        - **dataset** : Boolean (default True) - if False and a single data_var,
+        - **dims**: list of string (default None) - order of dimensions to apply
+        - **dataset**: Boolean (default True) - if False and a single data_var,
         return a DataArray
-        - **datagroup** : Boolean (default True) - if True return a DataGroup with
+        - **datagroup**: Boolean (default True) - if True return a DataGroup with
         metadata and data_arrays
-        - **ntv_type** : Boolean (default True) - if True add ntv-type to the name"""
+        - **ntv_type**: Boolean (default True) - if True add ntv-type to the name"""
         return Xdataset.from_dataframe(self._obj, **kwargs).to_scipp(**kwargs)