Beautify some docs properties
See original GitHub issueThere are some things in the auto-generated docs website that could be improved.
- Sometimes, the listed attributes are enclosed in double backticks (e.g. https://martinos.org/mne/dev/generated/mne.preprocessing.Xdawn.html#mne.preprocessing.Xdawn, https://martinos.org/mne/dev/generated/mne.decoding.CSP.html#mne.decoding.CSP). These double backticks get rendered in the docs, which is probably not what we want.
- If there is a references section, each listed reference is preceded by
(1, 2)
which should point to all occurrences in the text. However, the2
entry is there even though a reference is only mentioned once in the text, and thus the link doesn’t work. - I wonder if it’s correct to use double backticks when referring to arguments in the description (see e.g. the CSP docs, where the
reg
parameter is referred to in the description). In the type description of the parameters, these are usually rendered italic, so maybe we should enclose only with single backticks to be consistent.
Issue Analytics
- State:
- Created 5 years ago
- Comments:8 (8 by maintainers)
Top Results From Across the Web
8 Google Docs formatting tricks to make your files pretty - Zapier
So let's cut to the chase: here are a few of my favorite Google Docs formatting tips. Power up your Google apps with...
Read more >beautify-web/js-beautify: Beautifier for javascript - GitHub
This little beautifier will reformat and re-indent bookmarklets, ugly JavaScript, unpack scripts packed by Dean Edward's popular packer, as well as partly ...
Read more >File Difference - Code Beautify
File Difference tool will help you to compare text files, XML, JSON, Code, String, binary files. Upload files, Copy and Paste String/Text, Load...
Read more >GSAP Best Practices - beautify order of properties? - GreenSock
I was just wondering if anyone has established beautify setups to share? I've grown accustomed to using the order of CSS properties I...
Read more >How to Create Beautiful and Engaging Emails with Google Docs
When your email really matters, there are certain things you want to get right. Formatting, phrasing, structure, content: all things that ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Yes, any other choice would require a discussion 😃
Yes it’s in #5120