Skip to content
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

Document ConstantPathNode fields #2140

Merged
merged 5 commits into from
Apr 23, 2024

Conversation

matthew-healy
Copy link
Contributor

This PR updates config.yml to add documentation for the fields of ConstantPathNode.

config.yml Outdated Show resolved Hide resolved
config.yml Outdated Show resolved Hide resolved
@kddnewton kddnewton added the documentation Improvements or additions to documentation label Jan 17, 2024
@matthew-healy
Copy link
Contributor Author

Not sure why the C documentation generation is failing - I can run doxygen Doxyfile fine locally. Is that check known to be flaky? 🤔

@kddnewton
Copy link
Collaborator

Nope, not flaky. Looks like there's a warning about Foo in the output of doxygen in the test run

@matthew-healy
Copy link
Contributor Author

matthew-healy commented Jan 17, 2024

The issue was that doxygen read the ::Foo in the comment as a reference to some C++ code, which it then couldn't find. Have just removed that part of the comment.

(I couldn't repro it locally initially because I'd forgotten to run bundle exec rake templates 😅).

config.yml Outdated Show resolved Hide resolved
config.yml Outdated Show resolved Hide resolved
@kddnewton kddnewton merged commit dc3b986 into ruby:main Apr 23, 2024
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants