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.

Return types not included in documentation

See original GitHub issue

At one point there were examples showing what was returned and what the different enums mean, but I can’t seem to find where those exist anymore. I would expect the doc page for something like az repos pr list to show me the object that gets returned so I can understand what different things mean, but no matter where I look, I get redirected back to the page that just shows me the list of options for the command.

What happened to the example responses? Can those be linked in the documentation somewhere?


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:7 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
jonestcommented, Jun 29, 2022

@jonest you should be able to get sample responses here https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-requests/get-pull-requests?view=azure-devops-rest-6.0#response.

Thanks! I completely forgot about looking at the REST response docs. Is that something that you plan to include in the CLI docs, too? Some sort of “see also” or something 😃

Also when you said enum, did you mean the enum of status parameter? --status {abandoned, active, all, completed}

Yes, that’s what I was referring to. The response was just returning the integer, but I didn’t know which integer corresponded to which status

1reaction
RakeshMohanMSFTcommented, Jun 24, 2022

@jonest Thank you for reaching out, we are looking into it.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Warning states Object is defined and referenced, but not ...
I am receiving quite a few warnings of the same type describing that a component of my code is defined, and referenced within...
Read more >
How do I document the return type which comes from another ...
How do I document A::foo() return type, when it is not certain what B::baz() will return? In the future, B::baz() may change, in...
Read more >
missing-return-type-doc / W9012 - Pylint
This message is raised only when parameter accept-no-return-doc is set to no . This message is emitted by the optional 'parameter_documentation' checker which ......
Read more >
W9012 (missing-return-type-doc) | pylint-errors - GitHub Pages
A curated list of pylint errors with explanation and examples.
Read more >
JSDoc Reference - TypeScript: Documentation
Note any tags which are not explicitly listed below (such as @async ) are not ... @type; @param (or @arg or @argument );...
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