Skip to content
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.

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

docs: remove duplicate entries for bot.{name,nick,user} #1857

Merged
merged 1 commit into from
May 13, 2020

Conversation

dgw
Copy link
Member

@dgw dgw commented May 8, 2020

Description

Sphinx 3 started complaining about duplicate object descriptions. I'm too lazy to keep updating my local Sphinx (was still on 1.8.x until today), but I spotted the warnings in Netlify site build logs.

Resolves these warnings (taken from the sopel-irc/sopel.chat#29 merge build on Netlify):

6:45:58 AM: /opt/build/repo/_sopel/sopel/bot.py:docstring of sopel.bot.Sopel.name:1:
WARNING: duplicate object description of sopel.bot.Sopel.name, other instance in bot,
use :noindex: for one of them
6:45:58 AM: /opt/build/repo/_sopel/sopel/bot.py:docstring of sopel.bot.Sopel.nick:1:
WARNING: duplicate object description of sopel.bot.Sopel.nick, other instance in bot,
use :noindex: for one of them
6:45:58 AM: /opt/build/repo/_sopel/sopel/bot.py:docstring of sopel.bot.Sopel.user:1:
WARNING: duplicate object description of sopel.bot.Sopel.user, other instance in bot,
use :noindex: for one of them

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
  • I have tested the functionality of the things this change touches

Notes

This commit can be cherry-picked to the 7.0.x maintenance branch just in case we actually release another patch version, but I don't think anything is actually broken because of this. The definitions in docs/source/bot.rst just make these three properties appear at the top of the built HTML page, instead of in alphabetical order with the rest of the things. (The duplicate rST defs came from b567c72, over four years ago. I think we're past needing them.)

Sphinx 3 started complaining about duplicate object descriptions. I'm
too lazy to keep updating my local Sphinx (was still on 1.8.x until
today), but I spotted the warnings in Netlify site build logs.
@dgw dgw added this to the 7.1.0 milestone May 8, 2020
@dgw dgw requested a review from a team May 8, 2020 12:12
@dgw dgw merged commit 40602c7 into master May 13, 2020
@dgw dgw deleted the fix-bot-sphinx-warnings branch May 13, 2020 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants