97 coding standards rebranch

[JhanSrbinovsky]

CABLE

Description

Add coding standards information to the Developer's Guide. The original branch was corrupted and it was unclear if the automated tests worked correctly. It was easier to restart than try to resolve within the first branch.

Fixes #97

Type of change

• New or updated documentation

Checklist

• The new content is accessible and located in the appropriate section.
• I have checked that links are valid and point to the intended content.
• I have checked my code/text and corrected any misspellings

---

📚 Documentation preview 📚: https://cable--128.org.readthedocs.build/en/128/

[JhanSrbinovsky]

arrrggggghhhhh - so where is the preview now. it looks like checks have passed. I thought it was supposed to be processed?

[tammasloughran]

https://cable--128.org.readthedocs.build/en/128/developer_guide/coding_standards/

Very strange that GitHub can't find the preview deplotment now.

I found it by clicking "Show all checks", then "Details" next to the readthedocs entry

[JhanSrbinovsky]

Thanks for the link. OK - so now to address your comments - 1 what do you mean by where are general rules? I thought maybe I had left in a black heading. Do you mean I should include that as a section?

2. you mentioned text edits - do you mean text edits you have already made (and if so where are they now) - OR that I should make some
3. Missing list?

[JhanSrbinovsky]

BTW - do you know how to see a rendered version of source code? That is the whole point of using MD right?

[tammasloughran]

Sorry. My first attempt didn't work. I'm still learning how to review.

[tammasloughran]

BTW - do you know how to see a rendered version of source code? That is the whole point of using MD right?

Well there is this:
https://cable--128.org.readthedocs.build/en/128/developer_guide/coding_standards/

Also there is the regular github rendering of the branch:
https://github.com/CABLE-LSM/CABLE/blob/97_coding_standards_rebranch/documentation/docs/developer_guide/coding_standards.md

[tammasloughran]

FYI: You can also accept changes in batch under the files changed tab of the pull request.

[JhanSrbinovsky]

BTW - do you know how to see a rendered version of source code? That is the whole point of using MD right?

Well there is this: https://cable--128.org.readthedocs.build/en/128/developer_guide/coding_standards/

Also there is the regular github rendering of the branch: https://github.com/CABLE-LSM/CABLE/blob/97_coding_standards_rebranch/documentation/docs/developer_guide/coding_standards.md

The 1st link - I like the ACTUNG!! Special Warning notice. You must've done this but I cant see it in mine, probably because I edited the same part of the code AND the code blocks don't reflect what I have locally

The 2nd link does

As there is no timestamp or something on the 1st IDK how to update it

[tammasloughran]

No more comments

[JhanSrbinovsky]

@ccarouge - we're waiting on your approval

[tammasloughran]

Reviewed

[ccarouge]

Sorry Jhan, I have a few comments. You don't have to accept everything. Let me know what you think.

[JhanSrbinovsky]

accept grammar

[JhanSrbinovsky]

clearing XX

[ccarouge]

I've noticed a few differences between the templates at the end and the naming convention for the subroutine names. Instead of listing the changes, I went ahead and made the changes myself. So we are ready to merge!