question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[DOC] Alphabetizing `docdict`

See original GitHub issue

I think the original organization of docdict was great when there were limited entries but now, in my opinion, it’s getting a bit unruly and disorganized. My suggestion would be to alphabetize and document the standardized format that the argument should go first with any specific separated by and underscore, i.e. there can be trans and trans_not_none which will be next to each other alphabetically and that way it will be easy to tell which docstring (i.e. (%(color_matplotlib)) goes to which argument (i.e. color) where %(matplotlib_color) for the argument color is a bit confusing that it goes to the argument color for a function such as f(..., color=None, ...).

cc @hoechenberger @agramfort

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:16 (12 by maintainers)

github_iconTop GitHub Comments

1reaction
alexrockhillcommented, Mar 2, 2022

I didn’t realize how big doctdict was already, I think this is a bit too late. What I thought might be a fun onboarding exercise looks like the endless PR to scare away new contributors! Sorry @andylikescodes!

I wrote a script to automate it but it still took an hour of fiddling.

1reaction
alexrockhillcommented, Feb 23, 2022

Hahaha @andylikescodes said he has a good amount of previous GitHub experience so I think that might have been mostly review for him, but in general, I think that’s a great idea. There is documentation about it https://mne.tools/dev/install/contributing.html but it’s really not by example, it’s quite long and if I were a new contributor I might not know where to start/how to do a PR.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Alphabetize in Google Docs - Nira
Google Docs does not have a sorting or alphabetizing feature built into it natively. Open the Google Doc with the list that you...
Read more >
How to Alphabetize in Google Docs Using a Free Add-on
A free add-on can help you alphabetize text in your Google Docs. Here's a guide on how to install and use it, so...
Read more >
How to Alphabetize in Google Docs - Wordable
This article will provide you with a step-by-step walkthrough so you won't have any issues sorting the content in Google Docs alphabetically.
Read more >
4 Easy Ways to Alphabetize in Google Docs - wikiHow
1. Open Google Docs. If you’re using a computer, navigate to https://docs.google.com/ in your browser. On your phone or tablet, open the Google...
Read more >
Built-in Types — Python 3.11.1 documentation
The principal built-in types are numerics, sequences, mappings, classes, instances and exceptions. Some collection classes are mutable. The methods that add, ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found