Skip to content

Commit c0d870e

Browse files
authored
Plugin sections review (#880)
* Plugin docs review * highlight plugins naming*
1 parent 69e8a75 commit c0d870e

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

extending/plugins.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ And it can be used in plugin importing the module:
142142
Storage, activation and sharing
143143
-------------------------------
144144

145-
Plugins are Python files stored under *~/.conan/plugins* folder and their file name should be the same used for activation.
145+
Plugins are Python files stored under *~/.conan/plugins* folder and **their file name should be the same used for activation** (without the
146+
*.py* extension).
146147

147148
The activation of the plugins is done in the *conan.conf* section named ``[plugins]``. The plugin names listed under this section will be
148149
considered activated.

reference/plugins.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ subsequent **pre**/**post** ``download_package()``/``upload_package()`` if that
146146
using :command:`conan create` or :command:`conan install`.
147147

148148
Function parameters
149-
--------------------
149+
-------------------
150150

151151
Here you can find the description for each parameter:
152152

@@ -193,14 +193,14 @@ Table legend:
193193
- **post**: Only available in ``post`` function.
194194
- **cache**: Only available when the context of the command executed is the local cache. e.g. :command:`conan create`,
195195
:command:`conan install`...
196-
- **user space**: Only available when the context of the command executed is the local cache. e.g. :command:`conan build`
196+
- **user space**: Only available when the context of the command executed is the user space. e.g. :command:`conan build`
197197

198198
.. note::
199199

200200
Path to the different folders of the Conan execution flow may be accessible as usual through the ``conanfile`` object. See
201201
:ref:`folders_attributes_reference` to learn more.
202202

203-
Some of this parameters does not appear in the signature of the function as they may not be available always (Mostly depending on the recipe
203+
Some of this parameters does not appear in the signature of the function as they may not be always available (Mostly depending on the recipe
204204
living in the local cache or in user space). However, they can be checked with the ``kwargs`` parameter.
205205

206206
.. important::

0 commit comments

Comments
 (0)