[FIX] sudo() docstring

rST uses double-backticks for literal text, not single
This commit is contained in:
Xavier Morel
2015-12-21 12:34:53 +01:00
parent 9e211ef127
commit f839c9358a
+9 -6
View File
@@ -5396,24 +5396,27 @@ class BaseModel(object):
Returns a new version of this recordset attached to the provided
user.
By default this returns a `SUPERUSER` recordset, where access control
and record rules are bypassed.
By default this returns a ``SUPERUSER`` recordset, where access
control and record rules are bypassed.
.. note::
Using `sudo` could cause data access to cross the boundaries of
record rules, possibly mixing records that are meant to be
isolated (e.g. records from different companies in multi-company
environments).
Using ``sudo`` could cause data access to cross the
boundaries of record rules, possibly mixing records that
are meant to be isolated (e.g. records from different
companies in multi-company environments).
It may lead to un-intuitive results in methods which select one
record among many - for example getting the default company, or
selecting a Bill of Materials.
.. note::
Because the record rules and access control will have to be
re-evaluated, the new recordset will not benefit from the current
environment's data cache, so later data access may incur extra
delays while re-fetching from the database.
"""
return self.with_env(self.env(user=user))