This commit is contained in:
Ian Clanton-Thuon 2022-04-08 19:07:34 -07:00
Родитель d8ce4aedcf
Коммит 8c96128cdc
8 изменённых файлов: 16 добавлений и 13 удалений

Просмотреть файл

@ -3,7 +3,7 @@
<p align="center"><a href="https://tsdoc.org/">https://tsdoc.org/</a></p>
</td></tr></table>
[![#tsdoc chat room](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://rushstack.zulipchat.com/#narrow/stream/266672-tsdoc) &nbsp; [![Build Status](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_apis/build/status/tsdoc/TSDoc%20CI%20Build?branchName=master)](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_build/latest?definitionId=5&branchName=master)
[![#tsdoc chat room](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://rushstack.zulipchat.com/#narrow/stream/266672-tsdoc) &nbsp; [![Build Status](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_apis/build/status/tsdoc/TSDoc%20CI%20Build?branchName=main)](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_build/latest?definitionId=5&branchName=main)
## Documentation Links

Просмотреть файл

@ -92,7 +92,7 @@
// *
// * Thus, warnings do not interfere with local development, but they will cause a CI job to fail, because
// * the Rush process itself returns a nonzero exit code if there are any warnings or errors. This is by design.
// * In an active monorepo, we've found that if you allow any warnings in your master branch, it inadvertently
// * In an active monorepo, we've found that if you allow any warnings in your main branch, it inadvertently
// * teaches developers to ignore warnings, which quickly leads to a situation where so many "expected" warnings
// * have accumulated that warnings no longer serve any useful purpose.
// *

Просмотреть файл

@ -15,7 +15,8 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/microsoft/tsdoc/tree/master/eslint-plugin"
"url": "https://github.com/microsoft/tsdoc",
"directory": "eslint-plugin"
},
"homepage": "https://tsdoc.org/",
"main": "lib/index.js",

Просмотреть файл

@ -275,24 +275,24 @@
* The URL of this Git repository, used by "rush change" to determine the base branch for your PR.
*
* The "rush change" command needs to determine which files are affected by your PR diff.
* If you merged or cherry-picked commits from the master branch into your PR branch, those commits
* If you merged or cherry-picked commits from the main branch into your PR branch, those commits
* should be excluded from this diff (since they belong to some other PR). In order to do that,
* Rush needs to know where to find the base branch for your PR. This information cannot be
* determined from Git alone, since the "pull request" feature is not a Git concept. Ideally
* Rush would use a vendor-specific protocol to query the information from GitHub, Azure DevOps, etc.
* But to keep things simple, "rush change" simply assumes that your PR is against the "master" branch
* But to keep things simple, "rush change" simply assumes that your PR is against the "main" branch
* of the Git remote indicated by the repository.url setting in rush.json. If you are working in
* a GitHub "fork" of the real repo, this setting will be different from the repository URL of your
* your PR branch, and in this situation "rush change" will also automatically invoke "git fetch"
* to retrieve the latest activity for the remote master branch.
* to retrieve the latest activity for the remote main branch.
*/
"url": "https://github.com/microsoft/tsdoc.git"
"url": "https://github.com/microsoft/tsdoc.git",
/**
* The default branch name. This tells "rush change" which remote branch to compare against.
* The default value is "master"
* The default value is "main"
*/
// "defaultBranch": "master",
"defaultBranch": "main"
/**
* The default remote. This tells "rush change" which remote to compare against if the remote URL is

Просмотреть файл

@ -21,7 +21,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th
The **tsdoc.json** file conforms to the [tsdoc.schema.json](
https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using
similar fields as the
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts)
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/configuration/TSDocTagDefinition.ts)
API used by `TSDocParser` from `@microsoft/tsdoc`.
Here's a simple example:

Просмотреть файл

@ -13,7 +13,8 @@
],
"repository": {
"type": "git",
"url": "https://github.com/microsoft/tsdoc"
"url": "https://github.com/microsoft/tsdoc",
"directory": "tsdoc-config"
},
"homepage": "https://tsdoc.org/",
"main": "lib/index.js",

Просмотреть файл

@ -42,7 +42,7 @@ Check out the [TSDoc Playground](https://tsdoc.org/play) for a cool live demo of
## API Usage
The [api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo) folder on GitHub illustrates how
The [api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo) folder on GitHub illustrates how
to invoke the TSDoc parser.
A separate NPM package [`@microsoft/tsdoc-config`](https://www.npmjs.com/package/@microsoft/tsdoc-config)

Просмотреть файл

@ -13,7 +13,8 @@
],
"repository": {
"type": "git",
"url": "https://github.com/microsoft/tsdoc"
"url": "https://github.com/microsoft/tsdoc",
"directory": "tsdoc"
},
"homepage": "https://tsdoc.org/",
"main": "lib-commonjs/index.js",