Skip to content

[PyFDB] docs: Markdown fix and reference to FDB docs#262

Draft
tbkr wants to merge 1 commit intodevelopfrom
hotfix/pyfdb-wheel-readme
Draft

[PyFDB] docs: Markdown fix and reference to FDB docs#262
tbkr wants to merge 1 commit intodevelopfrom
hotfix/pyfdb-wheel-readme

Conversation

@tbkr
Copy link
Copy Markdown
Contributor

@tbkr tbkr commented Apr 7, 2026

Description

Modified readme.md for pyfdb wheel.

Removed sphinx artifacts and added reference to FDB documentation.

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/dev-section/fdb/pull-requests/PR-262

@tbkr tbkr force-pushed the hotfix/pyfdb-wheel-readme branch from 0013735 to 440353a Compare April 7, 2026 13:29
@tbkr tbkr requested a review from Copilot April 7, 2026 13:30
@tbkr tbkr changed the title docs: Markdown fix and reference to FDB docs [PyFDB] docs: Markdown fix and reference to FDB docs Apr 7, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the PyFDB wheel README to remove Sphinx/reStructuredText artifacts and point users toward the upstream FDB documentation/resources.

Changes:

  • Converted FDB references from reStructuredText link syntax to Markdown.
  • Reordered and rewrote the “Documentation” section to reference FDB project pages and upstream repo guidance.
  • Normalized command snippet formatting in the installation section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/pyfdb/README.md
# PyFDB

`PyFDB` is the Python interface to the `FDB <github.com/ecmwf/fdb>`__, a
`PyFDB` is the Python interface to the [FDB](github.com/ecmwf/fdb), a
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

The Markdown link target github.com/ecmwf/fdb is missing a URL scheme, so GitHub will treat it as a relative link. Use an absolute URL (e.g., https://github.com/ecmwf/fdb).

Copilot uses AI. Check for mistakes.
Comment thread src/pyfdb/README.md
and notebooks.

The `FDB <github.com/ecmwf/fdb>`__ itself is part of `ECMWF`’s
The [FDB](github.com/ecmwf/fdb) itself is part of `ECMWF`’s
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

This Markdown link also uses github.com/ecmwf/fdb without a scheme, which will render as a relative link. Update to https://github.com/ecmwf/fdb.

Copilot uses AI. Check for mistakes.
Comment thread src/pyfdb/README.md

## Documentation

For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html).
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

There is an unmatched opening backtick before the link text, which will break Markdown rendering for the rest of the line/section. Remove the stray backtick (or add the matching closing backtick) so the link renders correctly.

Suggested change
For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html).
For implementation details and tooling, see the [FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html).

Copilot uses AI. Check for mistakes.
Comment thread src/pyfdb/README.md

For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html).

To build the latest documentation locally, follow the guide at [FDB](github.com/ecmwf/fdb).
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

This link target is missing a URL scheme (github.com/ecmwf/fdb), which makes it a relative link in Markdown. Use https://github.com/ecmwf/fdb instead.

Suggested change
To build the latest documentation locally, follow the guide at [FDB](github.com/ecmwf/fdb).
To build the latest documentation locally, follow the guide at [FDB](https://github.com/ecmwf/fdb).

Copilot uses AI. Check for mistakes.
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.19%. Comparing base (db7d78a) to head (440353a).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #262   +/-   ##
========================================
  Coverage    71.19%   71.19%           
========================================
  Files          376      376           
  Lines        23762    23762           
  Branches      2478     2478           
========================================
  Hits         16918    16918           
  Misses        6844     6844           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

3 participants