Skip to content

Commit fa13e08

Browse files
committed
fixed remaining warnings in docs
1 parent 5e30aaa commit fa13e08

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

Diff for: README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ pip3 install -r dev-requirements.txt
100100
After the installation has finished, you can run and view the documentation
101101
locally using:
102102
```
103-
make livedocs
103+
make livedocs-nlu
104+
make livedocs-core
104105
```
105106

106107
Visit the local version of the docs at http://localhost:8000 in your browser.

Diff for: docs/nlu/customcomponents.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Also be sure to read the section on the :ref:`section_component_lifecycle` .
2424
To get started, you can use this skeleton that contains the most important
2525
methods that you should implement:
2626

27-
.. literalinclude:: ../../tests/example_component.py
27+
.. literalinclude:: ../../tests/nlu/example_component.py
2828
:language: python
2929
:linenos:
3030

Diff for: rasa_nlu/components.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ def load(cls,
211211
calling `persist`. When the pipeline gets loaded again,
212212
this component needs to be able to restore itself.
213213
Components can rely on any context attributes that are
214-
created by :meth:`components.Component.pipeline_init`
214+
created by :meth:`components.Component.create`
215215
calls to components previous
216216
to this one."""
217217
if cached_component:
@@ -258,10 +258,10 @@ def train(self,
258258
This is the components chance to train itself provided
259259
with the training data. The component can rely on
260260
any context attribute to be present, that gets created
261-
by a call to :meth:`components.Component.pipeline_init`
261+
by a call to :meth:`rasa_nlu.components.Component.create`
262262
of ANY component and
263263
on any context attributes created by a call to
264-
:meth:`components.Component.train`
264+
:meth:`rasa_nlu.components.Component.train`
265265
of components previous to this one."""
266266
pass
267267

@@ -271,10 +271,10 @@ def process(self, message: 'Message', **kwargs: Any) -> None:
271271
This is the components chance to process an incoming
272272
message. The component can rely on
273273
any context attribute to be present, that gets created
274-
by a call to :meth:`components.Component.pipeline_init`
274+
by a call to :meth:`rasa_nlu.components.Component.create`
275275
of ANY component and
276276
on any context attributes created by a call to
277-
:meth:`components.Component.process`
277+
:meth:`rasa_nlu.components.Component.process`
278278
of components previous to this one."""
279279
pass
280280

@@ -404,12 +404,12 @@ def load_component(self,
404404
``load`` to create a new component.
405405
406406
Args:
407-
component_meta (dict):
407+
component_meta:
408408
the metadata of the component to load in the pipeline
409-
model_dir (str):
409+
model_dir:
410410
the directory to read the model from
411411
model_metadata (Metadata):
412-
the model's :class:`rasa_nlu.models.Metadata`
412+
the model's :class:`rasa_nlu.model.Metadata`
413413
414414
Returns:
415415
Component: the loaded component.

Diff for: rasa_nlu/model.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def load(model_dir: Text):
5959
"""Loads the metadata from a models directory.
6060
6161
Args:
62-
model_dir (str): the directory where the model is saved.
62+
model_dir: the directory where the model is saved.
6363
Returns:
6464
Metadata: A metadata object describing the model
6565
"""
@@ -290,7 +290,8 @@ def load(model_dir: Text,
290290
required packages for the components are installed
291291
before loading them.
292292
model_dir: The path of the model to load
293-
component_builder: The :class:`ComponentBuilder` to use.
293+
component_builder: The
294+
:class:`rasa_nlu.components.ComponentBuilder` to use.
294295
295296
Returns:
296297
An interpreter that uses the loaded model.

0 commit comments

Comments
 (0)