update docs

Alexander-Barth · Mar 15, 2022 · 246ddbb · 246ddbb
1 parent b9e07aa
commit 246ddbb
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/docs/src/dataset.md b/docs/src/dataset.md
@@ -9,14 +9,16 @@ NCDataset
 ```
 
 Useful functions that operate on datasets are:
+
 ```@docs
 keys(ds::NCDataset)
 haskey
 getindex(ds::NCDataset,varname::AbstractString)
 variable
+cfvariable
 sync
 close
-path
+NCDatasets.path
 ncgen
 varbyattrib
 write

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -28,7 +28,7 @@ To get started quickly see the [Quickstart](@ref) section. Otherwise see the fol
 * [Dimensions](@ref) : accessing/creating NetCDF dimensions
 * [Variables](@ref) : accessing/examining the variables (or dimensions) stored within a NetCDF dataset.
 * [Attributes](@ref) : accessing/creating NetCDF attributes
-* See [Performance tips](@ref), [Known issues](@ref), [Experimental features](@ref) for more information.
+* See [Performance tips](@ref performance_tips), [Known issues](@ref), [Experimental features](@ref) for more information.
 
 ## Quickstart
 

diff --git a/src/dataset.jl b/src/dataset.jl
@@ -238,6 +238,7 @@ Base.keys(ds::NCDataset) = listVar(ds.ncid)
 
 """
     path(ds::NCDataset)
+
 Return the file path (or the opendap URL) of the NCDataset `ds`
 """
 path(ds::NCDataset) = nc_inq_path(ds.ncid)
-Original file line number
+Diff line change
@@ Expand Up / @@ -238,6 +238,7 @@ Base.keys(ds::NCDataset) = listVar(ds.ncid) @@
     """
         path(ds::NCDataset)
     Return the file path (or the opendap URL) of the NCDataset `ds`
     """
     path(ds::NCDataset) = nc_inq_path(ds.ncid)
@@ Expand Down @@