Skip to content

Conversation

kunzaatko
Copy link
Contributor

Fixes #143

@kunzaatko
Copy link
Contributor Author

On another topic, I needed to add warnonly=[:missing_docs] to the make.jl file. This is because output_size is not included in the documentation. Should it be? Should I add it to the documentation and submit a PR?

Copy link
Member

@giordano giordano left a comment

Choose a reason for hiding this comment

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

Compat bounds aren't arbitrary, they're necessary, but can get stale

@kunzaatko kunzaatko force-pushed the remove-compat-restriction-for-docs branch from 1eb6cdb to 0972583 Compare August 20, 2025 17:22
@kunzaatko kunzaatko requested a review from giordano August 20, 2025 17:27
Copy link

codecov bot commented Aug 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.83%. Comparing base (d64a878) to head (043294e).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #144   +/-   ##
=======================================
  Coverage   94.83%   94.83%           
=======================================
  Files           4        4           
  Lines         445      445           
=======================================
  Hits          422      422           
  Misses         23       23           

☔ 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.

@giordano
Copy link
Member

On another topic, I needed to add warnonly=[:missing_docs] to the make.jl file. This is because output_size is not included in the documentation.

I don't see warnings in https://github.com/JuliaMath/AbstractFFTs.jl/actions/runs/17105669020/job/48513789015#step:7:8

@kunzaatko
Copy link
Contributor Author

I don't see warnings in https://github.com/JuliaMath/AbstractFFTs.jl/actions/runs/17105669020/job/48513789015#step:7:8

Not sure why that happens. I do not see it either. However if I build the documentation locally, I do:
image

@giordano
Copy link
Member

I don't see any output_size in the source code. I'm not sure you're using the right package when building the docs. In Julia v1.11 doing https://github.com/JuliaArrays/FixedSizeArrays.jl/blob/cd005e46e55527fb1b817d38326ecf91a849c8cc/docs/Project.toml#L8-L9 helps a lot, may be a good idea to do that here as well.

@kunzaatko kunzaatko force-pushed the remove-compat-restriction-for-docs branch from 3399b5a to 7e015e2 Compare August 20, 2025 20:30
@kunzaatko
Copy link
Contributor Author

I don't see any output_size in the source code. I'm not sure you're using the right package when building the docs. In Julia v1.11 doing https://github.com/JuliaArrays/FixedSizeArrays.jl/blob/cd005e46e55527fb1b817d38326ecf91a849c8cc/docs/Project.toml#L8-L9 helps a lot, may be a good idea to do that here as well.

Yeah! It was due to this. Apparently the latest version in the registry seems to have the function and the HEAD does not and this lead to the mismatch.

@kunzaatko kunzaatko force-pushed the remove-compat-restriction-for-docs branch from 71aa0b3 to 6f70ea1 Compare August 20, 2025 20:35
@kunzaatko
Copy link
Contributor Author

How do you propose the Documenter.yml to look? I tried to remove the instantiate but that fails. Can you explain please?

@kunzaatko kunzaatko requested a review from giordano August 20, 2025 20:43
@giordano
Copy link
Member

As I said in #144 (comment), instantiate is still necessary, but develop can be removed, as the sources section in the Project.toml does the right thing out-of-the-box.

@kunzaatko kunzaatko force-pushed the remove-compat-restriction-for-docs branch from 9482890 to 7ae06ee Compare August 20, 2025 20:48
@giordano giordano changed the title fix(docs): Remove the arbitrary compat restriction for Documenter fix(docs): Update Documenter setup Aug 20, 2025
This should keep the source that is documented to be the HEAD version
instead of the one in the registry.
@kunzaatko kunzaatko force-pushed the remove-compat-restriction-for-docs branch from 7ae06ee to 043294e Compare August 20, 2025 21:17
@giordano giordano merged commit 04a14f5 into JuliaMath:master Aug 20, 2025
12 of 15 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.

[feat] Documentation does not include the objects.inv file and is therefore unusabable with DocumenterInterLinks
2 participants