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

Triple slash comments in prisma schema file not working #104

Closed
Janushan opened this issue Apr 20, 2020 · 3 comments
Closed

Triple slash comments in prisma schema file not working #104

Janushan opened this issue Apr 20, 2020 · 3 comments
Assignees
Labels
bug/2-confirmed Bug has been reproduced and confirmed. kind/bug A reported bug. tech/engines Issue for tech Engines. topic: comments
Milestone

Comments

@Janushan
Copy link

Bug description

Problem adding comments to the prisma schema file so that it will show in GraphQL playground docs

As per the docs:
https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/prisma-schema-file

Triple slash comments are the way to show comments inside GraphQL playground docs however, inside my VS Code editor this is not working.

On save, the triple slashes are being automatically spaced
from /// to // / instead

How to reproduce

Steps to reproduce the behavior:

  1. Try to add a triple slash comment in the prisma schema file

Expected behavior

Triple slash comments show on the GraphQL playground docs.

Prisma information

Environment & setup

  • OS: MacOS
  • Database: PostgreSQL
  • Prisma version: 2.0.0-beta.2
  • Node.js version: 12.16.1
@pantharshit00 pantharshit00 transferred this issue from prisma/prisma Apr 21, 2020
@pantharshit00
Copy link
Contributor

I can confirm the problem. This is actually known problem as we have removed the concept of documentation comments /// in the parser so that we can enable automatic conversion of implcity relations to explict relations.

@pantharshit00 pantharshit00 added bug/2-confirmed Bug has been reproduced and confirmed. kind/bug A reported bug. labels Apr 21, 2020
@Janushan
Copy link
Author

@pantharshit00 Thanks for the quick reply!

I see. Is there any scope to support documentation comments?
If not, perhaps update the Prisma documentation so that the triple slash comments are removed?

@mavilein
Copy link
Member

This is fixed in latest master.

@mavilein mavilein added this to the Beta 6 milestone May 22, 2020
@mavilein mavilein self-assigned this May 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug/2-confirmed Bug has been reproduced and confirmed. kind/bug A reported bug. tech/engines Issue for tech Engines. topic: comments
Projects
None yet
Development

No branches or pull requests

4 participants