Skip to content

Remove unnecessary imports in plugin guide #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lagru merged 1 commit into from
Nov 8, 2026
Merged

Remove unnecessary imports in plugin guide #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/create_plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,9 @@ First we create the plugin:
```python
# my_array_plugin.py

from itertools import product

import lark
from docstub.plugins import hookimpl
from docstub.doctype import DoctypeTransformer, Expr, Term

my_grammar = """
GRAMMAR = """
%import doctype (start, WS_INLINE, ARRAY_NAME)
%extend ARRAY_NAME: "my_array"
%ignore WS_INLINE
Expand All @@ -33,7 +29,7 @@ my_grammar = """

@hookimpl
def docstub_load_doctype_grammar():
return my_grammar
return GRAMMAR
```

The enable the plugin in the configuration:
Expand Down Expand Up @@ -62,7 +58,7 @@ import lark
from docstub.plugins import hookimpl
from docstub.doctype import DoctypeTransformer, Expr, Term, expand_expression

my_grammar = """
GRAMMAR = """
%import doctype (start, WS_INLINE, qualname)
%extend qualname: "{" qualname ("," qualname)+ "}" -> expansion
%ignore WS_INLINE
Expand All @@ -89,7 +85,7 @@ class ExpansionTransformer(DoctypeTransformer):

@hookimpl
def docstub_load_doctype_grammar():
return my_grammar
return GRAMMAR


@hookimpl
Expand Down
Loading