Skip to content

Create task documentation for the ACCESS-ESM1.6 workflow - #161

Draft
paul-leopardi wants to merge 10 commits into
mainfrom
160-draft-doc
Draft

paul-leopardi wants to merge 10 commits into
mainfrom
160-draft-doc

Conversation

@paul-leopardi

Copy link
Copy Markdown
Collaborator

Closes #160
The draft documentation was produced using Google Gemni 3.8 Flash

@paul-leopardi
paul-leopardi added this pull request to stack #158 September 25, 2026 02:51
@read-the-docs-community

read-the-docs-community Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 CMIP7-Input | 🛠️ Build #34817924 | 📁 Comparing 9ba5654 against latest (d1cfb65)

  🔍 Preview build  

40 files changed · + 39 added · ± 1 modified

+ Added

± Modified

@paul-leopardi
paul-leopardi marked this pull request as draft September 28, 2026 04:30

@atteggiani atteggiani left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @paul-leopardi for working on this documentation update.

I think the overall changes could be classified in two main categories: docstrings changes (or in general any documentation/comment added directly in the source code) and documentation changes.

First, I would separate these changes in two different PRs, as they can be reviewed independently (and this makes it easier to review the documentation changes without having the visual clutter of all changed python code). Therefore, I would keep only the docstrings changes in this PR.

Docstrings changes

I haven't looked at the docstrings in detail, but I think for the moment it's a good idea to have some docstrings for all the functions, so when we refactor the code we have some help understanding what the function does.
Just noting that these docstrings will likely change when the functions get refactored and integrated in the new python package.

Documentation changes

Any documentation change should be developed on top of #163, which configures documentation according to the current ACCESS-NRI standards.

Also, I am not sure documentation changes are required at this point. The main reason is that the status of the code will change drastically after the refactoring and integration in the new python package. Therefore, documentation will need to be changed accordingly.
Currently this documentation is an "AI snapshot" of what's currently in the repo. I think something like this would be easier with a link to DeepWiki (we could add its badge to the README).

Base automatically changed from 150-scenariomip-ext to main October 6, 2026 05:48
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.

Produce draft documentation describing the current workflow and Python scripts

2 participants