Skip to content

Bad links in generated files #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EmilyBourne opened this issue Mar 27, 2025 · 3 comments · May be fixed by #132
Open

Bad links in generated files #131

EmilyBourne opened this issue Mar 27, 2025 · 3 comments · May be fixed by #132

Comments

@EmilyBourne
Copy link

EmilyBourne commented Mar 27, 2025

When using more complex C++ syntax some of the generated links are not quite right. This leads to warnings such as:

INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-16', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-26', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-36', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-46', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-56', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/classFluidMoments.md' contains a link '#function-operator()-66', but there is no such anchor on this page.
INFO    -  Doc file 'gyselalibxx/vector__field_8hpp.md' contains a link '#variable-enable_borrowed_vector_field<-vectorfield<-elementtype,-idxrangetype,-vectorindexsettype,-memoryspace,-layoutstridedpolicy->->', but there is
           no such anchor on this page.

In my repo, I can see the problem for:

  • operator() (missing in
    OVERLOAD_OPERATORS = [
    "operator=",
    "operator+",
    "operator-",
    "operator*",
    "operator/",
    "operator+=",
    "operator-=",
    "operator*=",
    "operator/=",
    "operator==",
    "operator%",
    "operator%=",
    "operator++",
    "operator--",
    "operator==",
    "operator!=",
    "operator<=",
    "operator>=",
    "operator>",
    "operator<",
    "operator!",
    "operator&&",
    "operator||",
    "operator~",
    "operator&",
    "operator|",
    "operator^",
    "operator<<",
    "operator>>",
    "operator~=",
    "operator&=",
    "operator|=",
    "operator^=",
    "operator<<=",
    "operator>>=",
    "operator[]",
    "operator*",
    "operator&",
    "operator->",
    "operator->*",
    ]
    )
  • operator-
  • operator-=
  • Templated variables e.g.
    template<class T>
    bool constexpr is_my_type_v = ..;
    
@EmilyBourne
Copy link
Author

The first and last problems are related to the markdown generation and have easy fixes (I will open a PR shortly). The problem with operator- seems to come during the translation from markdown to HTML but I have not yet found where this is done

@EmilyBourne EmilyBourne linked a pull request Mar 27, 2025 that will close this issue
@EmilyBourne
Copy link
Author

The problem with operator- is not due to the translation, it is just that unlike all other special characters in the operators - is preserved in the anchor

@JakubAndrysek
Copy link
Owner

Thanks for implementing.

More info there #135 (comment)

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 a pull request may close this issue.

2 participants