microsoftgraph / microsoftgraph/msgraph-bicep-types

Imrovements to properties documentation

Open
#112 1 comment 0 reactions 1 assignee View on GitHub

@jason-dou is already working on this.

Since May 23, 2024.

documentation enhancement graph-platform triaged
Dominant language
TypeScript
Stars
80
Forks
15
Avg merge
1h 21m
Merged PRs (30d)
3

Description

Is your feature request related to a problem? Please describe.
There are things that needs to be improved into documentation of properties around the default values if the property is not specified.
Example 1:
image

I cannot understand what is the default value of this property. Is it true or it is false. Can also the default to be null? Or may be the default depends on how other properties are configured. It will help a lot at the end of this description we have something simple as Default: true.

Example 2:
image

Also unclear if default value is something generic as en-US or null.

Such examples we can find on other properties.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Additional context
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.