Skip to content

Commit

Permalink
Reword warning on default values and add documentation building tip t…
Browse files Browse the repository at this point in the history
…o README
  • Loading branch information
MateuszKubuszok committed Dec 16, 2022
1 parent 2c4a3b2 commit 6a2dcd9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ sbt makeSite

HTML Documentation should be generated at `target/sphinx/html/index.html`.

Alternatively use Docker:

```bash
docker run --rm -v ./docs:/docs sphinxdoc/sphinx:3.2.1 bash -c "pip install sphinx-rtd-theme && make html"
```

## Thanks

Expand Down
4 changes: 2 additions & 2 deletions docs/source/transformers/default-values.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Enabling default values in generated transformer

.. warning::

Before 0.7.0 default values was enabled by default. Due to feedback it was
changed to disabled by default for safety.
Prior to version 0.7.0 fallback to default values was automatically enabled
and required explicit disabling.

Field's default value can be enabled as a target value when constructing
target object. The support for them has to be explicitly enabled to avoid
Expand Down

0 comments on commit 6a2dcd9

Please sign in to comment.