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

Struct layer API docs are missing layer.write_metadata() calls #845

Open
edmorley opened this issue Jul 22, 2024 · 0 comments
Open

Struct layer API docs are missing layer.write_metadata() calls #845

edmorley opened this issue Jul 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation libcnb

Comments

@edmorley
Copy link
Member

In the docs for the new struct API, it seems the cached_layer() example are missing the layer.write_metadata() calls.

For example in:
https://docs.rs/libcnb/latest/libcnb/build/struct.BuildContext.html#method.cached_layer

In the "more complex example" case (which actually needs the old metadata to compare against), the new metadata is never written, so the layer will always be invalidated.

It also feels like forgetting to include layer.write_metadata() is something end users might do too - so perhaps we need to emphasise the need to include it in as many parts of the docs as possible?

@edmorley edmorley added documentation Improvements or additions to documentation libcnb labels Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation libcnb
Projects
None yet
Development

No branches or pull requests

1 participant