Skip to content

Commit

Permalink
docs on data-types
Browse files Browse the repository at this point in the history
  • Loading branch information
felipenoris committed Sep 5, 2022
1 parent c626048 commit e8dfdc2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/src/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,18 @@ v1=3, v2=third

## Writing Excel Files

### Data Types

This package uses the following concrete types when handling XLSX files.

```@docs
XLSX.CellValueType
```

- Abstract types of these concrete types are converted to the appropriate concrete type when writing.

- `Nothing` values are converted to `Missing` when writing.

### Create New Files

Opening a file in `write` mode with `XLSX.openxlsx` will open a new (blank) Excel file for editing.
Expand Down
9 changes: 9 additions & 0 deletions src/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ struct CellDataFormat <: AbstractCellDataFormat
id::UInt
end

"""
CellValueType
Concrete supported data-types.
```julia
Union{String, Missing, Float64, Int, Bool, Dates.Date, Dates.Time, Dates.DateTime}
```
"""
const CellValueType = Union{String, Missing, Float64, Int, Bool, Dates.Date, Dates.Time, Dates.DateTime}

# CellValue is a Julia type of a value read from a Spreadsheet.
Expand Down

0 comments on commit e8dfdc2

Please sign in to comment.