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: do it with style: interact with the bot #2013

Merged
merged 1 commit into from
Feb 9, 2021

Conversation

Exirel
Copy link
Contributor

@Exirel Exirel commented Jan 6, 2021

Description

As many questions have arisen on IRC about formatting and stuff, I figured I could improve the documentation about that. There is now a new section in the chapter "Interact with the bot" about working with the bot "with style".

Reviewers may be confused as to why I had to add custom roles and CSS class, but worry not, that's the only way to do it properly.

We may want to add further warnings about control code, because formatting in IRC depends on the client's implementation.

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

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I know this will get posted on IRC: @Exirel I found the energy to review #2013 now. 😛

docs/source/_static/custom.css Outdated Show resolved Hide resolved
docs/source/_static/custom.css Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
@Exirel Exirel requested a review from dgw January 26, 2021 23:24
@Exirel
Copy link
Contributor Author

Exirel commented Jan 26, 2021

All fixed!

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, this is just about ready. Feel free to squash at the same time as you apply these tiny little suggestions (put [skip CI] in the commit message when applying, so Travis won't try to build until you force-push the squashed version).

docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Outdated Show resolved Hide resolved
docs/source/plugin/bot.rst Show resolved Hide resolved
Co-authored-by: dgw <dgw@technobabbl.es>
@Exirel Exirel force-pushed the docs-talk-with-style branch from 46775a2 to 2c4c5ca Compare February 7, 2021 14:15
@Exirel
Copy link
Contributor Author

Exirel commented Feb 7, 2021

Done.

@dgw dgw merged commit cfbc505 into sopel-irc:master Feb 9, 2021
@Exirel Exirel deleted the docs-talk-with-style branch May 1, 2021 17:54
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