From ef2ebef737a1ae26af76792c1c1c6366b8397f6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anders=20Fredrik=20Ki=C3=A6r?= <31612826+anders-kiaer@users.noreply.github.com> Date: Wed, 2 Sep 2020 14:36:39 +0200 Subject: [PATCH] Fix doc typos (#262) --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e12beca0..f2190399 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -305,17 +305,17 @@ the plugin author needs only do three things: def get_some_data(some, arguments) -> pd.DataFrame: ``` 3) In the plugin class, define a class method `add_webvizstore` which - returns a list of tuples. The first plugin in each tuple is a reference - to a function, the second plugin is itself a list of argument combinations. + returns a list of tuples. The first item in each tuple is a reference + to a function, the second item is a list of argument combinations + (formatted as dictionaries with `'argument_name': value` pairs). + Arguments with a default value in the function signature does not need to + be provided in the argument dictionaries. The author of the plugin should provide a list of all the argument combinations that are imaginable during runtime of the application. Since it is a class method, the author has access to all the user provided arguments. - Arguments with a default value in the function signature does not need to - be provided in the argument dictionaries. - A full example could look like e.g.: ```python