-
Notifications
You must be signed in to change notification settings - Fork 67
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
docs: linked the wiki page explaining FLINT modules #173
base: master
Are you sure you want to change the base?
Conversation
@@ -47,6 +47,10 @@ Distribution) and include: | |||
- Decomposition module | |||
- RothC soil carbon module | |||
|
|||
More information about these modules can be found `here`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please avoid using here
. Refer on our modules documentation
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change has been made
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, @Namyalg I have just put up a few thoughts. Do let me know what do you think?
What is a module? | ||
----------------- | ||
|
||
A module is a self-contained set of operations that determine the state |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A question that may arise in a reader's mind is-- "What kind of operations?"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO linking the operations.rst
here should serve the purpose
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add the hyperlink
How do modules operate? | ||
----------------------- | ||
|
||
Each module reads (or is provided with – see Unit Controller) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a new reader's prespective-
'see Unit Controller' for what?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The concept of a unit controller is not very clear, can we have a page/section for this and link it everywhere it is mentioned?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest removing unit controllers for now.
Modules for disturbance events | ||
------------------------------ | ||
|
||
Disturbance events occur intermittently (rather than for every step in a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be a good idea to add a line at the beginning about what are Disturbance events are before jumping it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the interpretation of a disturbance can be added first, then about the modules
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Thanks for opening the Pull Request for moja global. Happy contributing ✨