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 index.rst #16168
base: main
Are you sure you want to change the base?
Update index.rst #16168
Conversation
Use ellipses consistently in menu items and commands jupyterlab#16025 Updated the JupyterLab documentation to mention Apple's Human Interface Guidelines for menus' style improvements.
Thanks for making a pull request to jupyterlab! |
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.
Thank you for working on this!
I would suggest to move the added text from index to either:
Can you update the title of the PR to reflect the content (what does this PR change) rather than which files it edits?
Finally, I left a comment on the alert added. It does not render in the preview for me, I am not sure if we want to keep it but if we do let's use the native admonition.
.. .. only:: html | ||
|
||
<div class="alert alert-warning" role="alert"> | ||
<strong>Note:</strong> The following section provides guidelines for menu item labeling based on Apple's Human Interface Guidelines. | ||
</div> |
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.
I am not sure if this should be an alert. It currently does not render at all:
If it should be a visible admonition, let's implement it using the native admonitions syntax, for example with .. note:
jupyterlab/docs/source/user/toc.rst
Lines 24 to 31 in 73a947d
within your document. | |
.. note:: | |
Markdown headings with a HTML tag that contains the class ``jp-toc-ignore`` will be ignored; | |
e.g. ``# Title <a class="jp-toc-ignore"></a>``. | |
Automatic section numbering will go through your Notebook and number your sections and |
which render like this:
See https://jupyterlab.readthedocs.io/en/latest/user/toc.html
Use ellipses consistently in menu items and commands #16025
Updated the JupyterLab documentation to mention Apple's Human Interface Guidelines for menus' style improvements.
References
Code changes
User-facing changes
Backwards-incompatible changes