Fix documention minor issues #2250
Conversation
AmirRezaM75
requested review from
bterlson,
daviwil,
markcowl,
allenjzhang and
timotheeguerin
as code owners
|
Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status): Website: https://cadlwebsite.z1.web.core.windows.net/prs/2250/ |
| model PetId { | ||
| @path petId: int32; | ||
| } | ||
|
|
There was a problem hiding this comment.
Model is used in line 126. having it here, make it more clear
| @@ -70,7 +70,7 @@ emit: | |||
| - emitter1 | |||
| ``` | |||
|
|
|||
| in `<my-pkg>/tspconfig.yaml`, enable `emitter2` using the options specified in the parent `tspconfig.yaml | |||
| in `<my-pkg>/proj2/tspconfig.yaml`, enable `emitter2` using the options specified in the parent `tspconfig.yaml | |||
There was a problem hiding this comment.
In my opinion the second example is not necessary and has been covered above.
There was a problem hiding this comment.
that's fair, feel free to remove that one
| @@ -17,7 +17,7 @@ The guidelines in this article are used in TypeSpec Core libraries. You can use | |||
| | scalar | camelCase | `scalar uuid extends string;` | | |||
| | model | PascalCase | `model Pet {}` | | |||
| | model property | camelCase | `model Pet {furColor: string}` | | |||
| | enum | PascalCase | `model Pet {furColor: string}` | | |||
| | enum | PascalCase | `enum Direction {}` | | |||
| | enum member | camelCase | `enum Direction {up, down}` | | |||
There was a problem hiding this comment.
Although all examples mentioned here https://microsoft.github.io/typespec/language-basics/enums has PascalCase members 😕
There was a problem hiding this comment.
Good catch, sounds like we need to update the other docs too. They were written before we came to an agreement for the style guide
|
Hi @AmirRezaM75 thanks for the contribution, It seems like it hasn't picked up the cla agreement, I think it might be because it has the markdown quote prefix If you comment again without I think it should work! |
|
@microsoft-github-policy-service agree |
|
@timotheeguerin |
|
Seemed to have worked thanks! Yes the docs will get published automatically however I just noticed you updated the “latest” docs version in versioned_docs folder. Those are going to get overwritten next release(next week) by the content of docs/ would you mind making the same fixes there as well |
@timotheeguerin Done. |
No description provided.