Skip to content

Commit

Permalink
doc: assign_attrs
Browse files Browse the repository at this point in the history
  • Loading branch information
gauteh committed Oct 9, 2024
1 parent 81b302b commit 95fe217
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions trajan/traj.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,15 +308,27 @@ def assign_cf_attrs(self,
Parameters
----------
*kwargs
Attribute names and values
creator_name : string
Creator of dataset (optional).
creator_email : string
Creator email (optional).
title : string
Title of dataset (optional).
summary : string
Description of dataset (optional).
*kwargs : dict
Additional attribute key and values (optional).
Returns
-------
Dataset
Updated dataset with provided attributes, in addition to several CF standard attributes,
including Conventions, featureType, geospatial_lat_min etc.
"""
ds = self.ds.copy(deep=True)
Expand Down Expand Up @@ -407,7 +419,7 @@ def time_to_next(self) -> pd.Timedelta:
Returns
-------
DataArray
Scalar timedelta for 1D objects (fixed timestep), and DataArray of same size as input for 2D objects
Scalar timedelta for 1D objects (fixed timestep), and DataArray of same size as input for 2D objects
See Also
--------
Expand Down

0 comments on commit 95fe217

Please sign in to comment.