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

DOC: Add command summaries to datalad.api.__doc__ #2728

Merged
merged 12 commits into from
Aug 4, 2018

Commits on Aug 2, 2018

  1. 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__.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    7ea60b8 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    244d223 View commit details
    Browse the repository at this point in the history
  3. 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.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    08f7037 View commit details
    Browse the repository at this point in the history
  4. RF: Extract CLI-independent parts from get_description_with_cmd_summary

    We'll use the list of command summaries in datalad.api.__doc__.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    689fe72 View commit details
    Browse the repository at this point in the history
  5. RF: Move get_cmd_summaries from cmdline/main to interface/base

    This will be used outside of the command-line interface.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    92042b4 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    d7b1b2e View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    1061d1f View commit details
    Browse the repository at this point in the history
  8. 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__.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    194f1a7 View commit details
    Browse the repository at this point in the history
  9. RF: Move "get interface doc" code into dedicated function

    An upcoming commit will use this to add command summaries in
    datalad.api.__doc__.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    2424bad View commit details
    Browse the repository at this point in the history
  10. 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.
    kyleam committed Aug 2, 2018
    Configuration menu
    Copy the full SHA
    bdbaca1 View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    84278f4 View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2018

  1. Configuration menu
    Copy the full SHA
    8d1d125 View commit details
    Browse the repository at this point in the history