Skip to content

Commit 7a86a28

Browse files
authored
Serialization doc updated (#58575)
This PR updates the documentation for Serialization.jl to recommend using the .jls extension for serialized Julia data, following common community conventions. Fixes: #58544
1 parent a4ab110 commit 7a86a28

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

stdlib/Serialization/docs/src/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,15 @@ Serialization.serialize
1111
Serialization.deserialize
1212
Serialization.writeheader
1313
```
14+
15+
### Recommended File Extension
16+
17+
While the Serialization module does not mandate a specific file extension, the Julia community commonly uses the `.jls` extension for serialized Julia files.
18+
19+
Example:
20+
21+
```julia
22+
open("model.jls", "w") do io
23+
serialize(io, my_model)
24+
end
25+
```

0 commit comments

Comments
 (0)