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.

Improve description for not documented parameters

See original GitHub issue


screenshot-2fd github io 2016-11-19 20-32-31

Issue Analytics

  • State:open
  • Created 7 years ago
  • Reactions:1
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

sp00mcommented, Nov 3, 2017

Could have nice to have this in the doc, I’ve been looking for it as well 😉

OlivierCuypcommented, Sep 7, 2018

@2fd , I was playing around following you examples without success for my use case. I’m using an API gateway which does the schema stitching with micro-services (all in graphql). So I read a bit more on the difference between simple comments and description.

So I changed from:

# Base user type
type User {
  # User unique id
  id: ID!
  # The full user name
  name: String!
  # The user email address
  email: Email!


"Base user type"
type User {
  "Its unique id, which have to be an Int"
  id: ID!
  "The full user name"
  name: String!
  "The user email address"
  email: Email!

And that works ! As @sp00m proposed, it would be really nice to have this documented. I can do a PR if you want …

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to document a method with parameter(s)? - Stack Overflow
One example: Parameters ---------- x : type Description of parameter `x`.
Read more >
How to Write Meta Descriptions | Google Search Central
Learn how to write a quality meta description tag that may be displayed for your page in Google Search results by following these...
Read more >
Step 3: Parameters (API reference tutorial) | Documenting APIs
The different types of parameters are often documented in separate groups on the same page. Not all endpoints contain each type of parameter....
Read more >
Effective Dart: Documentation
We all know code should be self-documenting and not all comments are helpful. ... description of the method and highlight parameters using square...
Read more >
4. More Control Flow Tools — Python 3.11.1 documentation
Look closely: the else clause belongs to the for loop, not the if statement. ... The actual parameters (arguments) to a function call...
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 Post

No results found

github_iconTop Related Hashnode Post

No results found