Commit graph

26 commits

Author SHA1 Message Date
Henrique Moody 52614d600d
Organize documentation for "Read the Docs"
The current documentation is hosted via GitHub pages rendered by
"Couscous". Every time we need a new version of the documentation
published we need to manually execute the "couscous".

This commit reorganize the documentation to be published to
"Read the Docs" because it will also allow us to have documentations per
version of the library most importantly provider a search field for the
documentation.

The documentation will be then published on:
https://respect-validation.readthedocs.io/

Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
2018-08-23 01:59:39 +02:00
Henrique Moody cb4fb83b3e
Revert "Elaborated API styles documentation"
This reverts commit eb2621fafe.
2018-05-19 16:17:57 +02:00
Henrique Moody c6b6a4c425
Revert "Tested and fixed documentation"
This reverts commit 4357349ff0.
2018-05-19 16:17:47 +02:00
Nick Lombard 4357349ff0
Tested and fixed documentation
Fixed concrete and builder api documentation
2018-04-22 12:35:48 +02:00
Nick Lombard eb2621fafe
Elaborated API styles documentation
Transferred documentation from issue #90 Dynamic chaining
2018-04-22 01:12:42 +02:00
Augusto Pascutti 9460a4c237 Ensure namespace separator on appended prefixes
Appending a prefix to search new rules under required that the namespace
(prefix) being added always ended with a trailing namespace character so
rules could successfully be found under it. This ensures that the
separator is always present.

Changes a test for a rule which does not implement Respect's interface
to an actual class so we don't need to declare one to use as a stub.
2016-04-23 21:20:54 -03:00
Caio César Tavares 6d04b77762 Fix ExceptionInterface namespace. 2016-01-29 18:32:59 -02:00
Henrique Moody 474afaa2ec Remove "ValidationExceptionInterface" 2015-10-23 09:00:31 -02:00
Henrique Moody 67e072ebd3 Remove "NestedValidationExceptionInterface" 2015-10-23 09:00:18 -02:00
Henrique Moody 8c9c587597 Improvements and fixes on exceptions
There were some cases when the exceptions was not displayed property
when using nested exception, this commit fix the problem and also
display messages in Markdown list.
2015-10-22 03:01:41 -02:00
Henrique Moody 66027b85a5 Documentation improvements
- Add a space after comments with `//`;
- Add missing "See also" sections in some files
2015-10-19 22:55:05 -02:00
Henrique Moody 9c49dd3bcf Use short array syntax 2015-10-17 22:56:32 -03:00
Henrique Moody d53811f7b7 Remove user-defined optional values
Since we have NotOptional rule now, we must keep the same opposite
behaviour between these two rules.

This commit also improve and increase tests from Optional rule and
updates the documentation.

No tests was made for messages on MODE_DEFAULT because it's not possible
for a while since we don't have such much granularity control, but after
some fixes on Not rule, maybe we will be able to do that, that's why I
kept the messages on OptionalException.
2015-10-15 11:14:20 -03:00
Henrique Moody 255269bfb3 Rename rule "String" to "StringType" 2015-10-07 11:52:03 -03:00
Henrique Moody 9b85df4601 Rename rule "Int" to "IntVal" 2015-10-07 11:46:57 -03:00
Henrique Moody 937fa6b183 Create documentation for message localization
Also define the `translator` param to the related rules in
`AbstractNestedException`.
2015-10-07 10:18:31 -03:00
Henrique Moody c6dcba9fac Create "CHANGELOG.md" file 2015-10-07 02:56:23 -03:00
Henrique Moody 455ff9b318 Create "Optional" rule 2015-10-07 02:44:33 -03:00
Henrique Moody 3e45647b81 Make all rules mandatory 2015-10-07 01:00:39 -03:00
Henrique Moody 845d976264 Add an example of custom rule in the Feature Guide 2015-09-25 20:11:34 -03:00
Henrique Moody 69f433db6b Create method getMessages() on nested exception 2015-09-10 19:20:31 -03:00
Henrique Moody c39e7fb08c Standard for "See also:" on documentation 2015-08-20 01:38:41 -03:00
Henrique Moody cb7cd9bcbf Update "See also" section in *.md files
Create an horizontal rule right before the block.
2015-02-21 07:35:02 -02:00
Henrique Moody db0f71575f Create "Age" rule
Also add a deprecation note in "MinimumAge" rule documentation.
2015-02-19 19:38:16 -02:00
Henrique Moody 459ba86196 Fix typos and code blocks on documentation 2015-02-17 14:50:05 -02:00
Henrique Moody f422020d0e Update documentation 2015-02-12 14:37:33 -02:00