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

feat: minor improvements to the new docstring blocks #181

Merged
merged 5 commits into from
Sep 21, 2024
Merged

Conversation

avik-pal
Copy link
Member

@avik-pal avik-pal commented Sep 19, 2024

@avik-pal avik-pal marked this pull request as ready for review September 19, 2024 23:46
@avik-pal
Copy link
Member Author

Seems to be working: https://luxdl.github.io/DocumenterVitepress.jl/previews/PR181/api. I collapsed the docs just as a demo.

The reason for change 1 is mostly because https://lux.csail.mit.edu/dev/api/Lux/utilities#Lux.Training.apply_gradients! looks visually strange with > # ..... and the clickable area was too small

docs/src/api.md Outdated Show resolved Hide resolved
@avik-pal
Copy link
Member Author

@asinghvi17
Copy link
Collaborator

asinghvi17 commented Sep 20, 2024

This looks good to me! I still don't like that the font size in docstrings is smaller than the main body, though - it's hard to read.

Copy link
Collaborator

@lazarusA lazarusA left a comment

Choose a reason for hiding this comment

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

I like it as it is. Let's merge.

docs/src/code_example.md Outdated Show resolved Hide resolved
@avik-pal avik-pal merged commit 865cd35 into master Sep 21, 2024
2 checks passed
@avik-pal avik-pal deleted the ap/collapse branch September 21, 2024 00:08
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.

support CollapsedDocStrings option from @meta block
3 participants