How to contribute multiple documentation edits?

[patrickwalton]

First off, thank you for creating, sharing, and maintaining this! It's an incredible resource!

I recently read through the documentation and found a number of typos and broken links. I'd like to contribute fixes. I read the contributing readme and it says we should create a new ticket for each pull request. This would be too tedious to do for each edit. Can I bundle my documentation changes into one ticket and pull request? Bundling, then correcting the pull request in response to comments, seems more efficient for everyone than creating dozens of tickets and pull requests.

[joaogvcarneiro]

Creating one issue and an associated pull request for cleaning up typos and missing links is reasonable. Feel free to do so, and if the developers feel it should be broken into different issues/PRs, then we'll suggest that. Thanks for contributing!

[schaubh]

To contribute code, I'll ask you to sign a contributor agreement. In the future this will be integrated into the BSK GitHub process. But, for now it is a manual process. Please email me directly and I'll send you the PDF. We need all contributors to agree that the code provided is free of proprietary or export control challenges, and that this is releases as open source for all to use.

[ephraim271]

Using this thread for other doc fixes, perhaps can be part of the same PR
Missing mtbParamsInMsg in Module I/O messages section for MtbEffector

https://hanspeterschaub.info/basilisk/Documentation/simulation/dynamics/MtbEffector/MtbEffector.html?highlight=mtbeffector#_CPPv411MtbEffector

[schaubh]

Thanks, I'll create a branch apply theses fixes.

[schaubh]

I have added the missing input and output messages to this module, and removed the two messages that are not part of of this effector module. Have you come across other documentation issues I can address in my current doc_fix branch?

[ephraim271]

Missing param docstrings in examples (pylint)

scenarioAlbedo.py:160:0: W9015: "albedoData" missing in parameter documentation (missing-param-doc)
scenarioDataToViz.py:92:0: W9015: "attType" missing in parameter documentation (missing-param-doc)
scenarioFormationMeanOEFeedback.py:90:0: W9015: "numOrbits" missing in parameter documentation (missing-param-doc)
scenarioGroundMapping.py:168:0: W9015: "useCentral" missing in parameter documentation (missing-param-doc)
scenarioDragRendezvous.py:126:0: W9015: "modelName" missing in parameter documentation (missing-param-doc)
MultiSatBskSim/scenariosMultiSat/scenario_BasicOrbitMultiSat.py:328:0: W9015: "environment" missing in parameter documentation (missing-param-doc)
MultiSatBskSim/scenariosMultiSat/scenario_BasicOrbitMultiSat_MT.py:234:0: W9015: "environment, numThreads" missing in parameter documentation (missing-param-doc)

[ephraim271]

In dipoleMapping
http://hanspeterschaub.info/basilisk/Documentation/fswAlgorithms/effectorInterfaces/dipoleMapping/dipoleMapping.html
"not that" -> "note that"

Thats all for now! In general the documentation has been very helpful.