Skip to content

Conversation

@Exirel
Copy link
Contributor

@Exirel Exirel commented Jul 26, 2021

Description

This is a first attempt at a documentation about time management for Plugin author. I think way more could be written, yet it will do for now. I don't want to have something blocked in a perpetual draft state because "it could be better". Of course it can be better, and it'll be. In future PRs.

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

@dgw dgw added this to the 8.0.0 milestone Oct 31, 2021
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.

Set the 8.0 milestone as a goal. 😁

I'm a little bit 🤔 about putting this in plugin/bot.rst, but there isn't really a better place other than shoehorning it into api.rst before the automodule docs for tools.time.

@Exirel
Copy link
Contributor Author

Exirel commented Dec 16, 2021

but there isn't really a better place

And maybe we could split bot.rst into different files? Like so:

  • plugin/bot.rst
    • plugin/bot/talk.rst
    • plugin/bot/style.rst
    • plugin/bot/channels.rst
    • plugin/bot/time.rst

What do you think? If you agree, I'd suggest to ship this PR, then split in a future PR.

@Exirel Exirel marked this pull request as ready for review December 16, 2021 14:01
@Exirel Exirel requested a review from dgw December 16, 2021 14:02
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.

Nitpick mode engaged, again… Are you tired of me yet? 🙉

I do indeed like the idea of making the bot-related docs a bit more digestible by splitting them into separate pages, and I also agree that that's best left for a future patch.

Note I'm only submitting this as "Request changes" because apparently I didn't submit the previous review as such, and I want this PR to show a clear status in the list—i.e. not look like it's unreviewed.

@Exirel Exirel requested a review from dgw December 16, 2021 15:24
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.

I like it. Instead of putting a ring on it, I'll just ask you to make LGTM happy. 😁

As per usual, with dgw's edits.

Co-authored-by: dgw <[email protected]>
@Exirel Exirel force-pushed the docs-plugin-about-time branch from 3e2b97f to 28080ac Compare December 21, 2021 22:21
@Exirel
Copy link
Contributor Author

Exirel commented Dec 21, 2021

I like it. Instead of putting a ring on it, I'll just ask you to make LGTM happy. grin

This is a joke:

Completed in 21s — No code changes detected

LGTM is now happy.

@dgw
Copy link
Member

dgw commented Dec 22, 2021

This is a joke

Of course it was a joke, lol. LGTM was only complaining because it "can't" analyze PRs with merge conflicts. 🤷‍♂️

@dgw dgw merged commit eed66d0 into sopel-irc:master Dec 22, 2021
@Exirel Exirel deleted the docs-plugin-about-time branch January 20, 2022 07:34
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