matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source 
Fix typos, expand and update FAQ.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-06-13 02:20:44 -04:00
parent 9836ca3ef3
commit 4d52dbde39
12 changed files with 139 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/mercs/0005-explicit-arguments.rst
View File

@@ -26,7 +26,7 @@ Motivation
==========
As the project grows, legibility of code becomes more important. Keyword
argument help document the use of services, clases and functions. Refactors
argument help document the use of services, classes and functions. Refactors
that affect the interface of services are also easier to find and update and
fix. Positional argument can cause a call to continue working as long as the
datatype of the argument remains the same. Usage of keyword arguments will
@@ -121,7 +121,7 @@ After:
Keyword arguments should also be used for callables that pass those to others
down the line like Django's ``reverse`` function. Any change to the name of
the ``pk`` URL parameter will raise an exception in this code alerting to
any posible incompatible use.
any possible incompatible use.
Example:
@@ -138,7 +138,7 @@ This becomes even more important when multiple URL parameters are used. Since
the API documentation is auto generated from the code itself, it would make
sense to rename the first URL parameter from ``pk`` to ``document_pk``. Such
change will cause all address to view resolutions to break forcing their
update and allowing all consumers' interface usage to remain synchonized to the
update and allowing all consumers' interface usage to remain synchronized to the
callable's interface.
.. code-block:: python

4
docs/mercs/0006-lower-information-disclose.rst
View File

@@ -16,7 +16,7 @@ MERC 6: Lower information disclose
Abstract
========
This MERC proposes the use of errors that don't disclose the existance of a
This MERC proposes the use of errors that don't disclose the existence of a
resource in the event that the requester doesn't have the required credentials.
Motivation
@@ -43,7 +43,7 @@ Since most view use the internal custom CRUD classes making a change to the
failure will fulfill the proposal of this MERC.
Adding the ``object_permission_raise_404`` class attribute and setting it
to default to False will allow fulfullin the goal of this MERC while
to default to False will allow fulfilling the goal of this MERC while
keeping the existing functionality intact.