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

Updates mdctl study documentation to list the correct tasks command #504

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

williamwan-medable
Copy link
Collaborator

@williamwan-medable williamwan-medable commented Feb 20, 2024

There is a mismatch between the mdctl study tasks command and help documentation. This PR updates the help documentation to reflect the correct usage of the command.

Current mdctl study documentation

 ~/github/Medable/mdctl  update_study_tasks_documentation ................................ direnv  system node  impure nix  11:25:23
> mdctl help study

    Study Tools

    Usage:

      mdctl study [command]

    Arguments:

      Command
        export - Exports the study from the current org
        import - Imports the study into the current org
        task [action] - Allows the select of tasks to export from the current org
        consent [action] - Allows the select of consent templates to export from the current org
        workflow [action] - Allows the select of workflow templates to export from the current org
        data-transfer - Allows the select of data transfer configs to export from the current org

Current behavior for task command

> mdctl study task --env env.orgCode
{
  object: 'fault',
  name: 'error',
  errCode: 'mdctl.error.unspecified',
  code: 'kError',
  message: 'Invalid command',
  status: 500,
  trace: null,
  path: undefined,
  resource: undefined,
  reason: undefined
}

New documentation

 ~/github/Medable/mdctl/packages/mdctl-cli  update_study_tasks_documentation !1 ...... 4s  direnv  system node  impure nix  11:29:52
> node cli.js help study

    Study Tools

    Usage:

      mdctl study [command]

    Arguments:

      Command
        export - Exports the study from the current org
        import - Imports the study into the current org
        tasks [action] - Allows the select of tasks to export from the current org
        consent [action] - Allows the select of consent templates to export from the current org
        workflow [action] - Allows the select of workflow templates to export from the current org
        data-transfer - Allows the select of data transfer configs to export from the current org

@alahawash alahawash merged commit a00e75e into main Feb 20, 2024
3 checks passed
@alahawash alahawash deleted the update_study_tasks_documentation branch February 20, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants