Skip to content

Add missing FDB API docs - #324

Draft
caraghbiner wants to merge 2 commits into
developfrom
docs/FDB-API
Draft

Add missing FDB API docs#324
caraghbiner wants to merge 2 commits into
developfrom
docs/FDB-API

Conversation

@caraghbiner

@caraghbiner caraghbiner commented Aug 6, 2026

Copy link
Copy Markdown
Member

Description

Add documentation for some undocumented FDB API functions.

Some initial comments:

  • WIP. First draft is AI generated, and will be edited by a human, because it frankly isn't very good (or accurate). PR will remain as draft until then.
  • I think some of the other API functions could use a touch up also. e.g. list currently has "List data present at the archive [...]" which does not make sense.
  • The goal is to write something just "good enough" – mediocre (but not bad) documentation is better than none. Each of these API functions could have an entire page of examples and explanations in the docs, but that is not in scope of this PR.

For tickets FDB-458/FDB-459/FDB-460/FDB-461/FDB-462/FDB-463.

Contributor Declaration

By opening this pull request, I affirm the following:

  • All authors agree to the Contributor License Agreement.
  • The code follows the project's coding standards.
  • I have performed self-review and added comments where needed.
  • I have added or updated tests to verify that my changes are effective and functional.
  • I have run all existing tests and confirmed they pass.

🌈🌦️📖🚧 Documentation FDB 🚧📖🌦️🌈
https://sites.ecmwf.int/docs/fdb/pull-requests/PR-324

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.

1 participant