Skip to content

Commit

Permalink
Fix describe topic references in help texts.
Browse files Browse the repository at this point in the history
  • Loading branch information
synrg committed Jun 17, 2023
1 parent cb6b8da commit c49f2db
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
10 changes: 5 additions & 5 deletions inatcog/commands/inat.py
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ async def set_autoobs_server(self, ctx, state: bool):
[p]inat set autoobs server off
```
See `[p]help autoobs` for usage of the feature.
See `[p]autoobs` for usage of the feature.
"""
if ctx.author.bot or ctx.guild is None:
return
Expand All @@ -664,7 +664,7 @@ async def set_dot_taxon(self, ctx, state: InheritableBoolConverter):
```
When `inherit` is specified, channel mode inherits from the server setting.
See `[p]help dot_taxon` for usage of the feature.
See `[p]dot_taxon` for usage of the feature.
""" # noqa: E501
if ctx.author.bot or ctx.guild is None:
return
Expand All @@ -690,7 +690,7 @@ async def dot_taxon_server(self, ctx, state: bool):
[p]inat set dot_taxon server off
```
See `[p]help dot_taxon` for usage of the feature.
See `[p]dot_taxon` for usage of the feature.
"""
if ctx.author.bot or ctx.guild is None:
return
Expand Down Expand Up @@ -827,7 +827,7 @@ async def inat_inspect(self, ctx, message_id: Optional[Union[int, str]]):
async def show_autoobs(self, ctx):
"""Show channel & server auto-observation mode.
See `[p]help autoobs` to learn about the feature."""
See `[p]autoobs` to learn about the feature."""
if ctx.author.bot or ctx.guild is None:
return

Expand All @@ -849,7 +849,7 @@ async def show_autoobs(self, ctx):
async def show_dot_taxon(self, ctx):
"""Show channel & server .taxon. lookup.
See `[p]help dot_taxon` to learn about the feature."""
See `[p]dot_taxon` to learn about the feature."""
if ctx.author.bot or ctx.guild is None:
return

Expand Down
2 changes: 1 addition & 1 deletion inatcog/commands/map.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ async def map(self, ctx, *, taxa_list):
[p]map 24255,24267
[p]map boreal chorus frog,western chorus frog
```
See `[p]help taxon` for help specifying taxa.
See `[p]taxon_query` for help specifying taxa.
"""

if not taxa_list:
Expand Down
10 changes: 5 additions & 5 deletions inatcog/commands/obs.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ async def _single_obs(self, ctx, query):
async def obs(self, ctx, *, query: Optional[str] = ""):
"""Observation matching query, link, or number.
- See `[p]help query` and `[p]help taxon_query` for help with *query* terms.
- See `[p]query` and `[p]taxon_query` for help with *query* terms.
- Use `[p]search obs` to find more than one observation.
- Normally just pasting a *link* will suffice in a channel where *autoobs* is on. See `[p]help autoobs` for details.
- Normally just pasting a *link* will suffice in a channel where *autoobs* is on. See `[p]autoobs` for details.
""" # noqa: E501
async with self._single_obs(ctx, query) as res:
if res:
Expand Down Expand Up @@ -159,7 +159,7 @@ async def obs_img(self, ctx, number: Optional[int], *, query: Optional[str] = ""
- Shows the image indicated by `number`, or if number is omitted, the first image.
- Command may be a *Reply* to an observation display instead of a query.
- See `[p]help query` and `[p]help taxon_query` for help with *query* terms.
- See `[p]query` and `[p]taxon_query` for help with *query* terms.
""" # noqa: E501
async with self._single_obs(ctx, query) as res:
if res:
Expand Down Expand Up @@ -202,7 +202,7 @@ async def life(self, ctx, *, query: Optional[TaxonReplyConverter]):
• By default, leaves are counted. Specify `per <rank>` with a valid rank to count taxa of that rank instead.
• For a *breakdown* per rank, specify `per main` for main ranks or `per any` for any rank.
• The title links to a user's life list page on the web, or if not for one person, the species tab of an observations search.
• See `[p]help query` and `[p]help taxon_query` for help with *query* terms, or `[p]help glossary` for an explanation of *leaf taxa*.
• See `[p]query` and `[p]taxon_query` for help with *query* terms, or `[p]glossary` for an explanation of *leaf taxa*.
e.g.
```
Expand Down Expand Up @@ -439,7 +439,7 @@ async def link(self, ctx, *, query):
[p]link <https://inaturalist.org/observations/12345>
```
See also `[p]help obs` and `[p]help autoobs`.
See also `[p]help obs` and `[p]autoobs`.
- Both of those methods for showing link info do not include the image, relying instead on the Discord to preview the link.
- If channel permissions don't allow users to preview links, but do allow the bot to, or if you prefer the information on top, you may find this command preferable.
""" # noqa: E501
Expand Down
14 changes: 7 additions & 7 deletions inatcog/commands/taxon.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ async def taxon(self, ctx, *, query: Optional[str]):
- *Reply* to another display to display its taxon.
- The *query* is optional when that display contains a taxon.
**Related help topics:**
- `[p]help taxon_query` for *taxon query* terms
- `[p]help query` for help with other *query* terms
- `[p]help reactions` describes the *reaction buttons*
- `[p]taxon_query` for *taxon query* terms
- `[p]query` for help with other *query* terms
- `[p]reactions` describes the *reaction buttons*
- `[p]help s taxa` to search and browse matching taxa
"""
async with self._get_taxon_response(ctx, query) as (query_response, _query):
Expand Down Expand Up @@ -253,7 +253,7 @@ async def ttest(self, ctx, *, query: Optional[str]):
async def tname(self, ctx, *, query: Optional[str]):
"""Taxon name only.
See `[p]help taxon_query` for help with the query.
See `[p]taxon_query` for help with the query.
```
"""
async with self._get_taxon_response(ctx, query) as (query_response, _query):
Expand All @@ -266,7 +266,7 @@ async def tname(self, ctx, *, query: Optional[str]):
async def species(self, ctx, *, query: Optional[str]):
"""Species information. (alias `[p]t` *query* `rank sp`)
See `[p]help taxon_query` for query help."""
See `[p]taxon_query` for query help."""
async with self._get_taxon_response(ctx, query, ranks=["species"]) as (
query_response,
_query,
Expand All @@ -285,7 +285,7 @@ async def taxon_related(self, ctx, *, taxa_list: str):
[p]related 24255,24267
[p]related boreal chorus frog,western chorus frog
```
See `[p]help taxon_query` for help specifying taxa.
See `[p]taxon_query` for help specifying taxa.
"""

if not taxa_list:
Expand Down Expand Up @@ -313,7 +313,7 @@ async def taxon_image(
):
"""Default image for a taxon.
See `[p]help taxon_query` for *query* help."""
See `[p]taxon_query` for *query* help."""
async with self._get_taxon_response(ctx, query) as (query_response, _query):
if query_response:
await self.send_embed_for_taxon_image(ctx, query_response.taxon, number)
Expand Down

0 comments on commit c49f2db

Please sign in to comment.