-
Notifications
You must be signed in to change notification settings - Fork 110
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
DOC: Add command summaries to datalad.api.__doc__ #2728
Commits on Aug 2, 2018
-
RF: Teach get_interface_groups about plugins
Otherwise we'll need to duplicate the "get groups, then append plugins" code when we add command information to datalad.api.__doc__.
Configuration menu - View commit details
-
Copy full SHA for 7ea60b8 - Browse repository at this point
Copy the full SHA 7ea60b8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 244d223 - Browse repository at this point
Copy the full SHA 244d223View commit details -
RF: cmdline: Use a dict rather than a list for short descriptions
This is cleaner because it avoids building up two lists and because downstream code that works with the description doesn't have to know the order, just the group name.
Configuration menu - View commit details
-
Copy full SHA for 08f7037 - Browse repository at this point
Copy the full SHA 08f7037View commit details -
RF: Extract CLI-independent parts from get_description_with_cmd_summary
We'll use the list of command summaries in datalad.api.__doc__.
Configuration menu - View commit details
-
Copy full SHA for 689fe72 - Browse repository at this point
Copy the full SHA 689fe72View commit details -
RF: Move get_cmd_summaries from cmdline/main to interface/base
This will be used outside of the command-line interface.
Configuration menu - View commit details
-
Copy full SHA for 92042b4 - Browse repository at this point
Copy the full SHA 92042b4View commit details -
Configuration menu - View commit details
-
Copy full SHA for d7b1b2e - Browse repository at this point
Copy the full SHA d7b1b2eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1061d1f - Browse repository at this point
Copy the full SHA 1061d1fView commit details -
RF: Move "load module from interface" code to a dedicated function
An upcoming commit will use this to add command summaries in datalad.api.__doc__.
Configuration menu - View commit details
-
Copy full SHA for 194f1a7 - Browse repository at this point
Copy the full SHA 194f1a7View commit details -
RF: Move "get interface doc" code into dedicated function
An upcoming commit will use this to add command summaries in datalad.api.__doc__.
Configuration menu - View commit details
-
Copy full SHA for 2424bad - Browse repository at this point
Copy the full SHA 2424badView commit details -
DOC: Add summary of commands to datalad.api.__doc__
Make it easier for users to discover what methods are available by looking at the help for the api module. One concern with this change could be that we're bringing in more modules than before, but inspecting sys.modules suggests that this is not the case. There is still some code duplication between api._command_summary and main.setup_parser that could pulled out, but that can be done later if someone thinks it's worth the effort. Closes datalad#2718.
Configuration menu - View commit details
-
Copy full SHA for bdbaca1 - Browse repository at this point
Copy the full SHA bdbaca1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 84278f4 - Browse repository at this point
Copy the full SHA 84278f4View commit details
Commits on Aug 3, 2018
-
Configuration menu - View commit details
-
Copy full SHA for 8d1d125 - Browse repository at this point
Copy the full SHA 8d1d125View commit details