Skip to content

Commit

Permalink
remove back quotes in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesknap committed Jul 14, 2023
1 parent ab4e25c commit a8f88dc
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# If true, Sphinx will warn about all references where the target cannot
# be found.
nitpicky = True
nitpicky = False

# A list of (type, target) tuples (by default empty) that should be ignored when
# generating warnings in "nitpicky mode". Note that type should include the
Expand Down
4 changes: 2 additions & 2 deletions src/ibek/ioc.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ def lookup_instance(cls, id):

def make_entity_models(support: Support):
"""
Create `Entity` subclasses for all `Definition` instances in the given
`Support` instance. Returns a list of the Entity subclasses Models.
Create Entity subclasses for all Definition instances in the given
Support instance. Returns a list of the Entity subclasses Models.
"""

entity_models = []
Expand Down
4 changes: 2 additions & 2 deletions src/ibek/modules.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Blank module to be populated with modules, which contain `Entity` subclasses
made with `make_entity_classes`"""
"""Blank module to be populated with modules, which contain Entity subclasses
made with make_entity_models"""
from typing import List

__all__: List[str] = []
4 changes: 2 additions & 2 deletions src/ibek/render.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ def render_text(
self, instance: Entity, text: str, when=When.every, suffix=""
) -> str:
"""
Add in the next line of text, honouring the ``once`` flag which will
Add in the next line of text, honouring the once flag which will
only add the line once per IOC.
Jinja rendering of values/args has already been done in Entity.__post_init__
but we pass all strings though jinja again to render any other jinja
in the IOC (e.g. database and function entries)
``once`` uses the name of the definition + suffix to track which lines
once uses the name of the definition + suffix to track which lines
have been rendered already. The suffix can be used where a given
Entity has more than one element to render once (e.g. functions)
"""
Expand Down

0 comments on commit a8f88dc

Please sign in to comment.