Skip to content

Commit

Permalink
remove problematic module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasIsensee committed Nov 23, 2024
1 parent cc13b5a commit ca1f0e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
13 changes: 10 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
```@docs
JLD2
```
JLD2 is a package for the [julia programming language](https://julialang.org/) for saving and loading data.
Highlights include:

- Simple API for basic usage: `jldsave(filename; data)` and `load(filename, "data")`
- JLD2 can serialize complex nested structures out of the box.
- JLD2 files adhere to the HDF5 format specification making it compatible with HDF5 tooling
and H5 libraries in other languages. (Can also read HDF5 files.)
- It is fast. JLD2 uses the julia compiler to generate efficient code for serializing complex structures.
- Users may provide custom serialization procedures to control how data gets stored.
- JLD2 provides *upgrade* mechanisms for data structures that need post-processing on load (for example when the julia types have changed)


## Overview
Expand Down
8 changes: 0 additions & 8 deletions src/JLD2.jl
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
module JLD2

# Use the README as the module docs
@doc let
path = joinpath("README.md")
include_dependency(path)
read(path, String)
end JLD2

using OrderedCollections: OrderedDict
using MacroTools: MacroTools, @capture
using Mmap: Mmap
Expand Down

0 comments on commit ca1f0e3

Please sign in to comment.