projectmesa
docs: Convert api/*.rst -> api/*.md via rst2myst
This has been brought up in dev meetings for a while, to have 1 format for documentation everywhere, not a mixture of .rst and .md. This is actually a long overdue change; @tpike3 could confirm this. The secondary reason is I want to try ChatGPT in making the docs clearer and more concise. See https://github.com/projectmesa/mesa/pull/2037.
You opened several similar PRs. None of the gives any reasoning to the change. My comment relates to all of those. What issue does this address? What benefits does this provide? Its quite tedious work to review this, so what reasoning am I missing?
This has been brought up in dev meetings for a while, to have 1 format for documentation everywhere, not a mixture of .rst and .md. This is actually a long overdue change; @tpike3 could confirm this. The secondary reason is I want to try ChatGPT in making the docs clearer and more concise. See #2037.
I made several orthogonal PR's so that they can be reviewed piecemeal, and I have self-reviewed each myself. Where manual fixes are applied in the subsequent commits.
Ok good, thanks for the reply. Would be good to include something like that in at least one of the PRs as a description in the future.
@rht, please always add a PR description. Not only for us as maintainers, but also for others looking around.
Structure for example it like this:
- Motivation or problem it solves
- Why it solves the problem this way
- (optionally) how it solves the problem (if non-trivial)
It's really important for reviews and users and contributors the PRs are accessible and as easy as possible to understand.
This is not optional, however small the PR.
Required statuses must pass before merging
Another #1962 bus factor issue!
@tpike3 or @jackiekazil could one of you remove all the required status checks? Approval by maintainers is already needed, we can interpret ourselves if the CI does what we want or not. We don't need a hard check for that.
@EwoutH - Do you have this option? or is this only admins?
Merge without waiting for requirements to be met (bypass branch protections)
@EwoutH - Do you have this option? or is this only admins?
Merge without waiting for requirements to be met (bypass branch protections)
This is only visible for admins.
Just for reference I added the required checks in response to https://github.com/projectmesa/mesa/pull/1788#issuecomment-1710291120 Sorry that this was done a bit haphazardly
But I agree we should remove them again.
Required statuses must pass before merging
Another #1962 bus factor issue!
@tpike3 or @jackiekazil could one of you remove all the required status checks? Approval by maintainers is already needed, we can interpret ourselves if the CI does what we want or not. We don't need a hard check for that.
Disabled the pass status checks, I will not merge these ones to make sure there are not issues.
