📝 Document "♻️ Split ResourcePool into three classes"

[shnizzedy]

Documents

Documents FCP-INDI/C-PAC#2131 by @shnizzedy

Description

Inserts Engine: NodeBlock, Resource, Tests between "Validation Schema" and "Pipeline Utilities" in "C-PAC nightly documentation » Developer Documentation » Pipeline Development"

Technical details

Includes a few formatting tweaks:

1. Fixes the heading level for "Validation Schema".
2. Sets just-the-object-name as the default (as opposed to fully-qualified-object-names).
3. If signatures > 90 characters, give one parameter per line instead of all on one line.
4. Include __init__ signature in class documentation.
5. Show typehints in both the signature and the content of each docstring.
6. Installs Pytest as part of docbuilding to autodoc tests.

Screenshot

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the source branch of the repository.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I tried letting the CI build this branch on a fork or built the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.