Verified Commit 4d59b234 authored by Alexis Reigel's avatar Alexis Reigel
Browse files

add documentation for the report

parent 982c884a
Pipeline #20584 passed with stage
in 3 minutes and 40 seconds
......@@ -58,6 +58,22 @@ import.errors[:model]
# => [#<struct Excelsior::Error row=3, errors=["First name can't be blank"]>]
```
### Report
A summary of the successfully inserted and failed records is available after
running the importer.
```ruby
import = UserImport.new
import.run
import.report
# => #<struct Excelsior::Report inserted=2, failed=1>
import.total
# => 3
```
### Extended API
You may want to pass an excel file per instance. You can also define your own
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment