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

docs: linked the wiki page explaining FLINT modules #173

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Namyalg
Copy link
Member

@Namyalg Namyalg commented Mar 30, 2022

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 ✨

@@ -47,6 +47,10 @@ Distribution) and include:
- Decomposition module
- RothC soil carbon module

More information about these modules can be found `here`_
Copy link
Member

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.

Copy link
Member Author

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

Copy link
Member

@shloka-gupta shloka-gupta left a 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
Copy link
Member

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?"

Copy link
Member Author

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

Copy link
Contributor

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)
Copy link
Member

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?

Copy link
Member Author

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?

Copy link
Contributor

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
Copy link
Member

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?

Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants