Skip to content

Commit

Permalink
Removing deprecated information from the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stephen-bunn committed Nov 6, 2017
1 parent 0cc91f2 commit d11fe1f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
1 change: 0 additions & 1 deletion docs/source/available-rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,6 @@ Record Rules
------------

These rules are applied to every record regardless to most rule filters documented in :ref:`getting_started-rule-filters`.
The only filter that applies to record rules is the ``sheet_filter`` rule.

:func:`~sandpaper.sandpaper.SandPaper.add_columns`
''''''''''''''''''''''''''''''''''''''''''''''''''
Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,6 @@ Translating Dates
'''''''''''''''''

The :func:`~sandpaper.sandpaper.SandPaper.translate_date` rule is quite nifty, but also has a couple limitations that need to be considered.
We utilize the clever `arrow <https://arrow.readthedocs.io/en/latest/>`_ library to handle date parsing which can be greedy at times.

However, because this parsing can take a considerable amount of time (when executed for many many items) it is recommended to also specify at least a ``column_filter`` for all instances of the rule.
Because dates are not a base type, the mentioned rule can sometimes incorrectly interpret strings as dates and apply a date translation where it is not needed.
For this reason, it is recommended to also specify at least a ``column_filter`` for all instances of the rule.
A ``value_filter`` would also help, but causes a lot of extra complexity that is most likely not required.

0 comments on commit d11fe1f

Please sign in to comment.