Skip to content

Conversation

AlexisRenchon
Copy link
Member

@AlexisRenchon AlexisRenchon commented Aug 22, 2025

closes #1346

preview: https://clima.github.io/ClimaLand.jl/previews/PR1367/

Note: before merging, need to checkout docs/make.jl

Only the structs themselves show up in the API docs, not the constructor functions.
This commit fixes this issue.

@AlexisRenchon AlexisRenchon force-pushed the ar/docs_api_constructors_fix branch 4 times, most recently from 13ed949 to 2c9f7b2 Compare August 26, 2025 18:28
@AlexisRenchon AlexisRenchon requested a review from kmdeck August 26, 2025 18:29
@AlexisRenchon AlexisRenchon marked this pull request as ready for review August 26, 2025 18:29
Copy link
Member

@kmdeck kmdeck left a comment

Choose a reason for hiding this comment

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

thanks, Alexis! Im glad this is working.

We also have a number of model constructors which we should add. I referenced some here, but I am sure I missed some. I think we basically want any constructor for a parameter, or model, in the docs, especially the "convenience" ones that make it easy to setup models from forcing, domain, and the toml dict.

This includes integrated models too (land, soilcanopy, soil snow, soil biogeochemistry).

@kmdeck kmdeck requested a review from juliasloan25 August 26, 2025 19:07
@AlexisRenchon AlexisRenchon force-pushed the ar/docs_api_constructors_fix branch from 2c9f7b2 to f7a8c5e Compare August 27, 2025 17:32
@AlexisRenchon AlexisRenchon requested a review from kmdeck August 27, 2025 17:40
@AlexisRenchon
Copy link
Member Author

thanks, Alexis! Im glad this is working.

We also have a number of model constructors which we should add. I referenced some here, but I am sure I missed some. I think we basically want any constructor for a parameter, or model, in the docs, especially the "convenience" ones that make it easy to setup models from forcing, domain, and the toml dict.

This includes integrated models too (land, soilcanopy, soil snow, soil biogeochemistry).

The integrated models have inner constructors, and the struct are in the API already, https://clima.github.io/ClimaLand.jl/stable/APIs/ClimaLand/ - I am not sure if we want to do something differently?

@kmdeck
Copy link
Member

kmdeck commented Aug 27, 2025

There are also some outer constructors for the integrated models:

function LandModel{FT}(;

function LandModel{FT}(

(for the LandModel - similar for soilcanopy)

@AlexisRenchon AlexisRenchon force-pushed the ar/docs_api_constructors_fix branch from f7a8c5e to 86ba544 Compare August 27, 2025 20:40
Copy link
Member

@kmdeck kmdeck left a comment

Choose a reason for hiding this comment

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

I think this is everything but the canopy model constructors:

function CanopyModel{FT}(;

function CanopyModel{FT}(

and the couple of comments left below. thank you!

@ph-kev ph-kev mentioned this pull request Aug 27, 2025
1 task
An outer constructor for `SnowParameters` which supplies defaults for
all arguments but `earth_param_set`.
"""
function SnowParameters{FT}(
Copy link
Member

Choose a reason for hiding this comment

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

this constructor is used in a few more places that need to be updated:

@AlexisRenchon AlexisRenchon force-pushed the ar/docs_api_constructors_fix branch 3 times, most recently from 5c11661 to bc9db15 Compare August 28, 2025 16:47
closes #1346

Only the structs themselves show up in the API docs, not the constructor
functions.
This commit fixes this issue.
@AlexisRenchon AlexisRenchon force-pushed the ar/docs_api_constructors_fix branch from bc9db15 to 805e901 Compare August 28, 2025 18:32
@AlexisRenchon AlexisRenchon merged commit 421506e into main Aug 28, 2025
13 of 15 checks passed
@AlexisRenchon AlexisRenchon deleted the ar/docs_api_constructors_fix branch August 28, 2025 19:36
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.

Constructors dont show up in the docs

4 participants