Skip to content

Conversation

@AlexanderWells-diamond
Copy link
Contributor

A fair amount of manual work went in to fixing the Docs, to make the existing .rst work with the new .md format. The new documentation should be reviewed to check it is sensible.

Using default Sphinx documentation layout.
Added MacOS and Windows to default CI.
Made some changes to Ruff configuration as it seems the template is
out of date.
Includes work to make old .rst docs work with .md format
Includes a fix in conf.py for broken autodoc_type_aliases
@codecov
Copy link

codecov bot commented Oct 8, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Also fixes the trivial changes that these changes highlight.
Note there are more complex linting errors spotted...
It's useful purely for the --version check in CI.
@AlexanderWells-diamond
Copy link
Contributor Author

@coretl The remaining errors are a handful of new linting errors, and a single test failure.

The linting errors are mostly regarding accessing private members, which would require actual code changes to fix.

The one test failure is strange - it's completely repeatable, but only after the copier template has been applied. I can't see any obvious packages that would cause it (I tried rolling back epicscorelibs and various pytest-* dependencies). It passed here a few months ago.

How do you want me to handle these issues?

I think this failure starts in Python3.8 due to changes in unraiseable
exception behaviour, or possibly in how pytest
handles them. See `sys.unraisablehook`.
@AlexanderWells-diamond AlexanderWells-diamond marked this pull request as ready for review October 9, 2024 08:19
@AlexanderWells-diamond
Copy link
Contributor Author

After discussion with @coretl I mostly ignored the linting errors, and then spent some time investigating the test failure and applying a (hacky) fix to it. This is now ready for review.

@AlexanderWells-diamond AlexanderWells-diamond merged commit 2ff5a6b into master Oct 10, 2024
@AlexanderWells-diamond AlexanderWells-diamond deleted the adopt_copier_template branch October 10, 2024 08:32
AlexanderWells-diamond added a commit that referenced this pull request Nov 1, 2024
This should have been done in PR #52
Note this means that aioca release 1.8 incorrectly claims Python3.7
support, when in actuality it does not work.
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