-
Notifications
You must be signed in to change notification settings - Fork 41
Fix docs build by adding missing docstrings and reorganizing function documentation #412
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
Conversation
Co-authored-by: yebai <[email protected]>
Co-authored-by: yebai <[email protected]>
docs/make.jl
Outdated
| makedocs(; | ||
| sitename="Bijectors", | ||
| format=Documenter.HTML(), | ||
| format=Documenter.HTML( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot, drop all changes in make.jl
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reverted all changes to docs/make.jl as requested. The file is now back to its original state. (58f8976)
| transform | ||
| logabsdetjac | ||
| logabsdetjacinv | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot, add the missing inverse here instead of below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved inverse to the user-facing methods section as requested. The function documentation is now located in the "Without mutation" subsection alongside the other user-facing functions. (3656243)
|
Bijectors.jl documentation for PR #412 is available at: |
Co-authored-by: yebai <[email protected]>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Co-authored-by: yebai <[email protected]>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Fixes the documentation build failures on CI by addressing missing docstrings for exported functions and improving the documentation organization.
Issues Fixed
The documentation build was failing with missing docstrings for two exported functions:
InverseFunctions.inverse :: Tuple{Bijectors.Transform}Bijectors.logabsdetjacinv :: Tuple{Any, Any}Changes Made
logabsdetjacinvandinverseto the user-facing methods section indocs/src/transforms.mdinversefunction from the API section to the "User-facing methods" section for better logical grouping with other transformation functionsVerification
The documentation now builds successfully:
All basic package functionality remains intact and the documentation structure is now properly organized with user-facing functions grouped logically.
Fixes the CI documentation workflow by ensuring all exported functions are properly documented.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.