documented run_system_cached issue#21617

[DylanD42]

Objective

• Function is throwing error
• Fixes Document that World::run_system_cached(_with) needs type hints for error handling #21617 by adding documentation to both run_system_cached functions

Solution

• Documented functions for future clarity

[github-actions]

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

[chescock]

Thanks for documenting this! It's my fault there is a sharp edge there, and I'm glad it's getting some warning labels.

I left some suggestions for things to add, but none of them are blocking. I also left some suggestions on how to fix the CI errors. I only commented on run_system_cached, but everything I said applies equally to the run_system_cached_with docs.

[alice-i-cecile]

Once the comments are addressed and CI is passing I'll take a look and probably merge this in :)

[chescock]

The docs on run_system_cached look good! Approving on the assumption that you're planning to make equivalent changes to run_system_cached_with :).