Skip to content

Commit 2eee9a9

Browse files
authored
Convert 'master' to 'main' for dartdoc and for external links where possible. (#3395)
1 parent f92ae00 commit 2eee9a9

File tree

11 files changed

+25
-25
lines changed

11 files changed

+25
-25
lines changed

.github/workflows/scorecards-analysis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on:
33
# Only the default branch is supported.
44
branch_protection_rule:
55
push:
6-
branches: [ master ]
6+
branches: [ main ]
77

88
# Declare default permissions as read only.
99
permissions: read-all

.github/workflows/test.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ name: Test
33
on:
44
# Run CI on pushes to the main branch, and on PRs against main.
55
push:
6-
branches: [ master ]
6+
branches: [ main ]
77
pull_request:
8-
branches: [ master ]
8+
branches: [ main ]
99
schedule:
1010
- cron: 0 15 * * *
1111

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ yet in the issue tracker, start by opening an issue. Thanks!
2121
## Making Changes
2222

2323
1. `grind` is needed to run dartdoc integration tests, see installed via `pub global activate grinder`.
24-
2. When a change is user-facing, please add a new entry to the [changelog](https://github.com/dart-lang/dartdoc/blob/master/CHANGELOG.md)
24+
2. When a change is user-facing, please add a new entry to the [changelog](https://github.com/dart-lang/dartdoc/blob/main/CHANGELOG.md)
2525
3. Please include a test for your change. `dartdoc` has both `package:test`-style unittests as well as integration tests. To run the unittests, use `grind test`.
2626
4. For major changes, run `grind compare-sdk-warnings` and `grind compare-flutter-warnings`, and include the summary results in your pull request.
2727
5. Be sure to format your Dart code using `dart format`, otherwise our CI will complain.
@@ -52,7 +52,7 @@ There are more added all the time -- run `grind --help` to see them all.
5252

5353
## License
5454

55-
Please see the [dartdoc license](https://github.com/dart-lang/dartdoc/blob/master/LICENSE).
55+
Please see the [dartdoc license](https://github.com/dart-lang/dartdoc/blob/main/LICENSE).
5656

5757
[user docs]: https://github.com/dart-lang/dartdoc#dartdoc
5858
[issue tracker]: https://github.com/dart-lang/dartdoc/issues

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Dart documentation generator
22

33
[![Build Status](https://github.com/dart-lang/dartdoc/workflows/Test/badge.svg)](https://github.com/dart-lang/dartdoc/actions?query=workflow%3ATest)
4-
[![Coverage Status](https://coveralls.io/repos/github/dart-lang/dartdoc/badge.svg?branch=master)](https://coveralls.io/github/dart-lang/dartdoc?branch=master)
4+
[![Coverage Status](https://coveralls.io/repos/github/dart-lang/dartdoc/badge.svg?branch=main)](https://coveralls.io/github/dart-lang/dartdoc?branch=main)
55
[![OpenSSF
66
Scorecard](https://api.securityscorecards.dev/projects/github.com/dart-lang/dartdoc/badge)](https://deps.dev/project/github/dart-lang%2Fdartdoc)
77

@@ -505,9 +505,9 @@ Please see the [dartdoc license][].
505505
Generated docs include:
506506

507507
* Highlight.js -
508-
[LICENSE](https://github.com/isagalaev/highlight.js/blob/master/LICENSE)
508+
[LICENSE](https://github.com/isagalaev/highlight.js/blob/main/LICENSE)
509509
* With `github.css` (c) Vasily Polovnyov <[email protected]>
510510

511511
[GitHub Issue Tracker]: https://github.com/dart-lang/dartdoc/issues
512-
[contributor docs]: https://github.com/dart-lang/dartdoc/blob/master/CONTRIBUTING.md
513-
[dartdoc license]: https://github.com/dart-lang/dartdoc/blob/master/LICENSE
512+
[contributor docs]: https://github.com/dart-lang/dartdoc/blob/main/CONTRIBUTING.md
513+
[dartdoc license]: https://github.com/dart-lang/dartdoc/blob/main/LICENSE

example/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Look for `BuildDartdocAPIDocs`.
1515
## Flutter
1616

1717
The Flutter team builds [API documentation for the Flutter SDK](https://api.flutter.dev)
18-
automatically. A [shell script](https://github.com/flutter/flutter/blob/master/dev/bots/docs.sh)
19-
wraps a [small dart program](https://github.com/flutter/flutter/blob/master/dev/tools/dartdoc.dart)
18+
automatically. A [shell script](https://github.com/flutter/flutter/blob/main/dev/bots/docs.sh)
19+
wraps a [small dart program](https://github.com/flutter/flutter/blob/main/dev/tools/dartdoc.dart)
2020
that manages the process.
2121

2222
## pub

lib/resources/styles.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ h1 .category {
551551
}
552552

553553
/* The badge under a declaration for things like "const", "read-only", etc. and for the badges inline like Null safety*/
554-
/* See https://github.com/dart-lang/dartdoc/blob/master/lib/src/model/feature.dart */
554+
/* See https://github.com/dart-lang/dartdoc/blob/main/lib/src/model/feature.dart */
555555
.feature {
556556
display: inline-block;
557557
background: var(--main-bg-color);

test/source_linker_test.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ void main() {
4040
lineNumber: 71,
4141
root: 'path',
4242
sourceFileName: 'path/to/file.dart',
43-
uriTemplate: 'http://github.com/base/master/%f%/L%l%')
43+
uriTemplate: 'http://github.com/base/main/%f%/L%l%')
4444
.href();
4545
expect(sourceLinkerHref(),
46-
equals('http://github.com/base/master/to/file.dart/L71'));
46+
equals('http://github.com/base/main/to/file.dart/L71'));
4747
});
4848

4949
test('Throw if only revision specified', () {
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
name: test_package_flutter_plugin
22
version: 0.1.0
33
description: A happy flutter almost plugin being documented
4-
homepage: http://github.com/dart-lang/dartdoc/tree/master/testing/test_package_flutter_plugin
4+
homepage: http://github.com/dart-lang/dartdoc/tree/main/testing/test_package_flutter_plugin
55

66
dependencies:
77
flutter:
88
sdk: flutter
99

1010
environment:
11-
sdk: ">2.12.0 <3.0.0"
12-
flutter: ">=0.1.4 <2.0.0"
11+
sdk: ">2.12.0 <4.0.0"
12+
flutter: ">=0.1.4 <4.0.0"

testing/test_package/dartdoc_options.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ dartdoc:
2424
- broken-link
2525
linkToSource:
2626
root: '.'
27-
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/master/testing/test_package/%f%#L%l%'
27+
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/main/testing/test_package/%f%#L%l%'

tool/grind.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ final String _pluginPackageDocsPath =
142142
String get dartdocOriginalBranch {
143143
var branch = Platform.environment['DARTDOC_ORIGINAL'];
144144
if (branch == null) {
145-
return 'master';
145+
return 'main';
146146
} else {
147147
log('using branch/tag: $branch for comparison from \$DARTDOC_ORIGINAL');
148148
return branch;
@@ -443,7 +443,7 @@ Future<String> createSdkDartdoc() async {
443443
await launcher.runStreamed('git', [
444444
'clone',
445445
'--branch',
446-
'master',
446+
'main',
447447
'--depth',
448448
'1',
449449
'https://dart.googlesource.com/sdk.git',

tool/mustachio/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ types:
153153
tag is inverted, and the syntax tree of the section block
154154
* [Partial][] node - a node containing the partial tag key
155155

156-
[Parser]: https://github.com/dart-lang/dartdoc/blob/master/lib/src/mustachio/parser.dart
157-
[Text]: https://github.com/dart-lang/dartdoc/blob/master/lib/src/mustachio/parser.dart#L422
158-
[Variable]: https://github.com/dart-lang/dartdoc/blob/master/lib/src/mustachio/parser.dart#L436
159-
[Section]: https://github.com/dart-lang/dartdoc/blob/master/lib/src/mustachio/parser.dart#L456
160-
[Partial]: https://github.com/dart-lang/dartdoc/blob/master/lib/src/mustachio/parser.dart#L477
156+
[Parser]: https://github.com/dart-lang/dartdoc/blob/main/lib/src/mustachio/parser.dart
157+
[Text]: https://github.com/dart-lang/dartdoc/blob/main/lib/src/mustachio/parser.dart#L422
158+
[Variable]: https://github.com/dart-lang/dartdoc/blob/main/lib/src/mustachio/parser.dart#L436
159+
[Section]: https://github.com/dart-lang/dartdoc/blob/main/lib/src/mustachio/parser.dart#L456
160+
[Partial]: https://github.com/dart-lang/dartdoc/blob/main/lib/src/mustachio/parser.dart#L477
161161

162162
## Generated renderer for a specific type which interprets templates at runtime
163163

0 commit comments

Comments
 (0)