Skip to content

Commit

Permalink
improve document
Browse files Browse the repository at this point in the history
  • Loading branch information
kongdd committed Aug 6, 2023
1 parent cd15373 commit ebd81db
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
32 changes: 29 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,46 @@ Pkg.add("NCTools")
```

```@docs
nc_info
ncdim_def
nc_open
nc_cellsize
Base.getindex
NCTools.NcDim
NCTools.ncdim_def
NCTools.make_dims
ncvar_def
ncatt_put
```

```docs
```@docs
nc_read
nc_write
nc_write!
```


## Utilities

```@docs
QDM
bilinear
nc_aggregate
nc_aggregate_dir
nc_combine
nc_subset
```


## CMIP functions

```@docs
CMIP.Tem_F2C
CMIP.heat_index
CMIP.get_model
CMIP.CMIPFiles_info
```
2 changes: 1 addition & 1 deletion src/ncvar_def.jl
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ close(ds)
nc_info(f)
```
@seealso [ncdim_def](ref)
@seealso [`ncdim_def`](@ref)
"""
function ncvar_def(ds, name, val, dims::Vector{<:AbstractString}, attrib=Dict();
compress=1, type=nothing, kwargs...)
Expand Down

0 comments on commit ebd81db

Please sign in to comment.