Skip to content
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

Add reduced complexity section to the developer's guide #10

Open
glemieux opened this issue May 20, 2022 · 2 comments
Open

Add reduced complexity section to the developer's guide #10

glemieux opened this issue May 20, 2022 · 2 comments
Labels
enhancement Feature that improves the function of the guide outside of content

Comments

@glemieux
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
The reduced complexity modes add complexity to the way fates handles patch areas. I find that I'm frequently having to revisit emails and code comments to correctly remember why we do things in a particular way. It'd be good to collect all that information in one space for developers to reference to gain a better understanding of how to maintain and build new code within this context.

Describe the solution you'd like
Add a section discussing the distinctions between the reduced complexity modes and full fates from a software perspective.

Describe alternatives you've considered
Code comments are good, but are distributed throughout the code by their nature. I'd like to consolidate it into one page in the developer's guide. The user's guide focuses on the scientific rationale for the mode and its expected inputs/outputs, not necessarily how it works under-the-hood.

@glemieux glemieux added the enhancement Feature that improves the function of the guide outside of content label May 20, 2022
@glemieux
Copy link
Collaborator Author

@rosiealice do you think you could take a crack at this?

@glemieux
Copy link
Collaborator Author

This could be cribbed somewhat from NGEET/fates-docs#34.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature that improves the function of the guide outside of content
Projects
Status: ❕Todo
Development

No branches or pull requests

1 participant