Skip to content

Commit

Permalink
Update markdown files with new linting (Aug 2023)
Browse files Browse the repository at this point in the history
  • Loading branch information
insspb committed Aug 10, 2023
1 parent 04c7827 commit dc82dcf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 10 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,4 @@ Flask-MongoEngine is distributed under [BSD 3-Clause License].

[Contribution guidelines]: CONTRIBUTING.md

[nox]: https://nox.thea.codes/en/stable/usage.html

[complete connection settings description]: http://docs.mongoengine.org/projects/flask-mongoengine/flask_config.html
7 changes: 3 additions & 4 deletions docs/db_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

```{important}
Flask-Mongoengine does not adjust database level behaviour of [mongoengine] fields
definition, except [keyword only definition] requirement. Everything other on
database level match [mongoengine] project. All parent methods, arguments (as
keyword arguments) and keyword arguments are supported.
definition, except [keyword only definition](#keyword-only-definition) requirement.
Everything other on database level match [mongoengine] project. All parent methods,
arguments (as keyword arguments) and keyword arguments are supported.
If you are not intend to use WTForms integration, you are free to use fields classes
from parent [mongoengine] project; this should not break anything.
Expand Down Expand Up @@ -44,4 +44,3 @@ check issue [#379] as example of one of such cases.
[mongoengine]: https://docs.mongoengine.org/
[#379]: https://github.com/MongoEngine/flask-mongoengine/issues/379
[integration]: forms
[keyword only definition]: #keyword-only-definition
6 changes: 2 additions & 4 deletions docs/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This allows to create several forms for same model, for different circumstances.

## Requirements

For correct integration behavior several requirements should be met:
For correct [integration] behavior several requirements should be met:

- Document classes should be used from Flask-Mongoengine
{class}`flask_mongoengine.MongoEngine` class, or from
Expand All @@ -41,7 +41,7 @@ For correct integration behavior several requirements should be met:

## Global transforms

For all fields, processed by Flask-Mongoengine integration:
For all fields, processed by Flask-Mongoengine [integration]:

- If model field definition have {attr}`wtf_validators` defined, they will be
forwarded to WTForm as {attr}`validators`. This is not protection from
Expand Down Expand Up @@ -1038,8 +1038,6 @@ Not yet documented. Please help us with new pull request.

[mongoengine]: https://docs.mongoengine.org/

[#379]: https://github.com/MongoEngine/flask-mongoengine/issues/379

[integration]: forms

[global transforms]: #global-transforms
Expand Down

0 comments on commit dc82dcf

Please sign in to comment.