-
-
Notifications
You must be signed in to change notification settings - Fork 402
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: split files into subfolders #2257
Conversation
3541f10
to
c9c3729
Compare
In lieu of a full review, which I don't really have the steam/spoons/whatever for at this moment, I would like to request that you create a patch for |
That's fair, I'll see it done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found some spoons. Didn't actually find that much to say, though. 😁
But not yet, apparently. |
This is related to PR2257 of sopel-irc/sopel repo. See also: sopel-irc/sopel#2257
And now it is done! See sopel-irc/sopel.chat#38 for more information. |
@dgw you can review now! And remember, this is only a first step. There are so much more to come in term of documentation! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While I haven't actually gone back over this again line-by-line, I'm aware that there will be more documentation patches coming before 8.0. There will be plenty of time to add/fix more stuff.
If nothing else, approving this means you can start on the next phase (new branch based on this one). The only thing I ask for now is to address _redirects
in sopel-irc/sopel.chat#38 (patch and/or comment). 😸
* split and replace package/api.rst * split package/irc.rst * minor adaptation of package's bot.rst and irc.rst * split package/config.rst * split tests.rst * move and split plugin/internals.rst And thanks dgw for the code review. Co-authored-by: dgw <dgw@technobabbl.es>
f97c433
to
42a7d7c
Compare
I'm gonna trust GitHub when it says I've still "viewed" all the changed files, and therefore trust that the diff is the same as what was approved. Rebasing pulled in way too many changes from the base branch for me to sort through those. 😅 (Yes, I still wish you wouldn't rebase "just because", when there's no merge conflict, @Exirel. And if you insist, please remember to update your remotes first… The apparent new base commit, 8b463a0, is old! 😝) |
I didn't rebase on the last version of master, IIRC, but I have to if I want to squash commits, don't I? |
You don't have to rebase onto any particular commit, but it's likely that you'll get "the last common commit between this branch and master" by starting your rebase with At least, I tried that on one of my somewhat stale topic branches and it started a rebase against the expected commit. YMMV as with most one-liners. There is a |
This is related to PR2257 of sopel-irc/sopel repo. See also: sopel-irc/sopel#2257
Description
Tin.
This is only a "first step" to reorganize the documentation around better chapters, and to rationalize where we put code references (i.e. documentation from docstrings).
I didn't change any text, it's really just moving things around.
This was initially based on #2237, #2226, and #2232, until they got merged.
Checklist
make qa
(runsmake quality
andmake test
)