diff --git a/wagtail_fedit/adapters/block.py b/wagtail_fedit/adapters/block.py index 2abdfa9..062b072 100644 --- a/wagtail_fedit/adapters/block.py +++ b/wagtail_fedit/adapters/block.py @@ -42,8 +42,8 @@ class BlockAdapter(BlockFieldReplacementAdapter): usage_description = "This adapter is used to edit a block of a streamfield." help_text_dict = { "block": "the block instance to edit. This can be a regular block isntance or a BoundBlock.", - "block_id": "the block ID to edit, required if block is not a BoundBlock.", - "admin": "if passed; the adapter will display admin URLs.", + "block_id": "the ID of the block to edit, required if block is not a BoundBlock.", + "admin": "if passed; the adapter will a quick- link to the Wagtail Admin for this block.", } required_kwargs = [ "block", diff --git a/wagtail_fedit/adapters/misc.py b/wagtail_fedit/adapters/misc.py index 63406c9..8d86f3e 100644 --- a/wagtail_fedit/adapters/misc.py +++ b/wagtail_fedit/adapters/misc.py @@ -24,7 +24,7 @@ class BackgroundImageFieldAdapter(BaseFieldFuncAdapter): identifier = "field_bg_image" usage_description = "This adapter is used for changing a css property of a target element to a background-image." help_text_dict = { - "target": "the target element to apply the background-image to.", + "target": "the target element to apply the background-image to - this should be a css selector.", "css_variable_name": "the CSS variable name to apply the background-image to. element.style.setProperty(css_variable_name, url);", } required_kwargs = FieldAdapter.required_kwargs + [ diff --git a/wagtail_fedit/management/commands/adapter_help.py b/wagtail_fedit/management/commands/adapter_help.py index a266526..ccf2bc6 100644 --- a/wagtail_fedit/management/commands/adapter_help.py +++ b/wagtail_fedit/management/commands/adapter_help.py @@ -17,7 +17,8 @@ def handle(self, *args, **options): " * The second argument is the model and field to edit. instance.modelfield", " * Absolute arguments (missing an equal sign) are optional and treated as booleans.", " * Keyword arguments wrapped in square brackets are optional. [key=value]", - " * The value of the adapter is the value of the field.", + " * Extra keyword arguments are optional; must be serializable to JSON and should not be too complex.", + " This is due to limits in URL-size when sharing context between views.", ] for identifier, adapter_class in adapter_registry.adapters.items():