Skip to content
CI

Move docstrings to struct definition so that we do not export undocumented symbols #263

Sign in to view logs

Move docstrings to struct definition so that we do not export undocumented symbols

Move docstrings to struct definition so that we do not export undocumented symbols #263

Triggered via pull request August 11, 2024 02:28
@KrastanovKrastanov
opened #76
docmovetostruct
Status Failure
Total duration 11m 24s
Artifacts –

ci.yml

on: pull_request
Documentation
10m 27s
Documentation
Matrix: test
Fit to window
Zoom out
Zoom in

Annotations

10 errors and 9 warnings
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`dagger`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumInterface.dagger`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`commutator`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumSymbolics.commutator`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`anticommutator`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumSymbolics.anticommutator`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`conj`](@ref)" in src/introduction.md. - No docstring found in doc for binding `Base.conj`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`transpose`](@ref)" in src/introduction.md. - No docstring found in doc for binding `Base.transpose`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`projector`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumInterface.projector`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`dagger`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumInterface.dagger`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`tr`](@ref)" in src/introduction.md. - No docstring found in doc for binding `LinearAlgebra.tr`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`ptrace`](@ref)" in src/introduction.md. - No docstring found in doc for binding `QuantumInterface.ptrace`.
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L44
Cannot resolve @ref for md"[`inv`](@ref)" in src/introduction.md. - No docstring found in doc for binding `Base.inv`.
Julia 1.10 - t=2 - ubuntu-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Julia 1.10 - t=2 - macOS-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Julia 1 - t=2 - ubuntu-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Julia 1 - t=2 - macOS-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Julia 1.10 - t=2 - windows-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Documentation: ../../../.julia/packages/DocumenterCitations/OyiEp/src/expand_bibliography.jl#L315
There were no citations
Documentation: ../../../.julia/packages/Documenter/qoyeC/src/utilities/utilities.jl#L46
5 docstrings not included in the manual: QuantumSymbolics.@withmetadata :: Tuple{Any} QuantumSymbolics.STensor QuantumSymbolics.num_to_sub :: Tuple{Int64} QuantumSymbolics.symbollabel QuantumSymbolics.DepolarizationCPTP These are docstrings in the checked modules (configured with the modules keyword) that are not included in canonical @docs or @autodocs blocks.
Documentation
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
Julia 1 - t=2 - windows-latest - x64 - pull_request
The following actions uses Node.js version which is deprecated and will be forced to run on node20: julia-actions/setup-julia@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/