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

Update style of auto-generated docs_info markdown string #875

Open
tcompa opened this issue Dec 13, 2024 · 3 comments
Open

Update style of auto-generated docs_info markdown string #875

tcompa opened this issue Dec 13, 2024 · 3 comments

Comments

@tcompa
Copy link
Collaborator

tcompa commented Dec 13, 2024

          > If we can also adapt to not show the titles quite so large or not default to setting titles based on docstring info parsed at all

If the user provides a full string, then that one will fully override the original one.
As per the current automatically-generated ones, I'll change the style of the generated markdown.

Originally posted by @tcompa in #874 (comment)

@jluethi
Copy link
Collaborator

jluethi commented Dec 13, 2024

Let's tackle this one we know how #874 is solved & we handle the layout for that

@tcompa
Copy link
Collaborator Author

tcompa commented Dec 16, 2024

This is how the new modal based on #874 would look like, in its current version:
image

@jluethi
Copy link
Collaborator

jluethi commented Dec 16, 2024

That's great. I guess it will be useful to highlight some key words in bold, but otherwise makes sense to me :) And with those smaller headers, I'm fine with it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants