Skip to content

Fix type hint#248

Merged
MatthieuDartiailh merged 1 commit intonucleic:mainfrom
AlexanderS:fix-type-hint
Sep 29, 2025
Merged

Fix type hint#248
MatthieuDartiailh merged 1 commit intonucleic:mainfrom
AlexanderS:fix-type-hint

Conversation

@AlexanderS
Copy link
Contributor

@AlexanderS AlexanderS commented Sep 29, 2025

Sphinx does not understand forwared references without quotes. So autodoc will fail if the quotes are missing.

You can see, that the modules is missing in the official documentation: https://atom.readthedocs.io/en/latest/api/atom.datastructures.html

You can see the error while building the documentation f.e. here: https://github.com/nucleic/atom/actions/runs/17932608666/job/50992636914

@AlexanderS
Copy link
Contributor Author

The CI error seems unrelated to this fix.

Sphinx does not understand forwared references without quotes. So autodoc will
fail if the quotes are missing.
@codecov
Copy link

codecov bot commented Sep 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.77%. Comparing base (dd2e0fc) to head (7148822).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #248   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          60       60           
  Lines        5351     5351           
  Branches     1144     1144           
=======================================
  Hits         4911     4911           
  Misses        411      411           
  Partials       29       29           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MatthieuDartiailh
Copy link
Member

Thanks for the fix

@MatthieuDartiailh MatthieuDartiailh merged commit bf17d45 into nucleic:main Sep 29, 2025
21 checks passed
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.

2 participants