Skip to content

Commit

Permalink
DOC: Try to keep <code> tags from appearing in rendered docs
Browse files Browse the repository at this point in the history
https://unidata.github.io/netcdf4-python/#netCDF4.Dataset
Scroll down to `format`: underlying file format.

Not sure if this should be ReST's ``code`` or Markdown's `code`, though the default role Sphinx assigns to single quotes should work (:any:`code`, I think is how sphinx would interpret `code`).  In any case, it works everywhere else, so hopefully it works here too.
  • Loading branch information
DWesl authored Nov 6, 2024
1 parent f7b00f8 commit e0efdb5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/netCDF4/_netCDF4.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -2331,8 +2331,8 @@ strings.
exception will be raised if a file with the same name already exists.
mode=`x` is identical to mode=`w` with clobber=False.
**`format`**: underlying file format (one of `'NETCDF4',
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
**`format`**: underlying file format (one of `'NETCDF4'`,
`'NETCDF4_CLASSIC'`, `'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
`'NETCDF3_64BIT_DATA'`.
Only relevant if `mode = 'w'` (if `mode = 'r','a'` or `'r+'` the file format
is automatically detected). Default `'NETCDF4'`, which means the data is
Expand Down

0 comments on commit e0efdb5

Please sign in to comment.