Skip to content

Commit a76bba6

Browse files
authored
fix api docs download path (#7560)
* fix api docs download path from #7555 * removes extra newlines in docstrings * add some logs when checking if website repo is clean * format
1 parent 937d51b commit a76bba6

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ jobs:
450450
if: ${{ matrix.generate_api_docs }}
451451
uses: actions/upload-artifact@v4
452452
with:
453-
name: api-docs
453+
name: api
454454
path: scripts/res/apiDocs/
455455

456456
pkg-pr-new:
@@ -495,11 +495,12 @@ jobs:
495495
uses: actions/download-artifact@v4
496496
with:
497497
artifact-ids: ${{ needs.build-compiler.outputs.api-docs-artifact-id }}
498-
path: data/api
498+
path: data
499499

500500
- name: Check if repo is clean
501501
id: diffcheck
502502
run: |
503+
git status
503504
if [ -z "$(git status --porcelain)" ]; then
504505
echo "clean=true" >> $GITHUB_OUTPUT
505506
else

runtime/Stdlib_Array.resi

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@ type t<'a> = array<'a>
1111
type arrayLike<'a>
1212

1313
/**
14-
`fromIterator(iterator)`
15-
16-
Creates an array from the provided `iterator`
14+
`fromIterator(iterator)` creates an array from the provided `iterator`
1715
1816
## Examples
1917
@@ -35,9 +33,7 @@ external fromIterator: Stdlib_Iterator.t<'a> => array<'a> = "Array.from"
3533
external fromArrayLikeWithMap: (arrayLike<'a>, 'a => 'b) => array<'b> = "Array.from"
3634

3735
/**
38-
`make(~length, init)`
39-
40-
Creates an array of length `length` initialized with the value of `init`.
36+
`make(~length, init)` creates an array of length `length` initialized with the value of `init`.
4137
4238
## Examples
4339

tests/analysis_tests/tests/src/expected/Completion.res.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Path Array.
213213
"kind": 12,
214214
"tags": [],
215215
"detail": "(~length: int, 'a) => array<'a>",
216-
"documentation": {"kind": "markdown", "value": "\n`make(~length, init)`\n\nCreates an array of length `length` initialized with the value of `init`.\n\n## Examples\n\n```rescript\nArray.make(~length=3, #apple)->assertEqual([#apple, #apple, #apple])\nArray.make(~length=6, 7)->assertEqual([7, 7, 7, 7, 7, 7])\n```\n"}
216+
"documentation": {"kind": "markdown", "value": "\n`make(~length, init)` creates an array of length `length` initialized with the value of `init`.\n\n## Examples\n\n```rescript\nArray.make(~length=3, #apple)->assertEqual([#apple, #apple, #apple])\nArray.make(~length=6, 7)->assertEqual([7, 7, 7, 7, 7, 7])\n```\n"}
217217
}, {
218218
"label": "lastIndexOfFrom",
219219
"kind": 12,
@@ -573,7 +573,7 @@ Path Array.
573573
"kind": 12,
574574
"tags": [],
575575
"detail": "Iterator.t<'a> => array<'a>",
576-
"documentation": {"kind": "markdown", "value": "\n`fromIterator(iterator)`\n\nCreates an array from the provided `iterator`\n\n## Examples\n\n```rescript\nMap.fromArray([(\"foo\", 1), (\"bar\", 2)])\n->Map.values\n->Array.fromIterator\n->assertEqual([1, 2])\n```\n"}
576+
"documentation": {"kind": "markdown", "value": "\n`fromIterator(iterator)` creates an array from the provided `iterator`\n\n## Examples\n\n```rescript\nMap.fromArray([(\"foo\", 1), (\"bar\", 2)])\n->Map.values\n->Array.fromIterator\n->assertEqual([1, 2])\n```\n"}
577577
}, {
578578
"label": "forEach",
579579
"kind": 12,
@@ -613,7 +613,7 @@ Path Array.m
613613
"kind": 12,
614614
"tags": [],
615615
"detail": "(~length: int, 'a) => array<'a>",
616-
"documentation": {"kind": "markdown", "value": "\n`make(~length, init)`\n\nCreates an array of length `length` initialized with the value of `init`.\n\n## Examples\n\n```rescript\nArray.make(~length=3, #apple)->assertEqual([#apple, #apple, #apple])\nArray.make(~length=6, 7)->assertEqual([7, 7, 7, 7, 7, 7])\n```\n"}
616+
"documentation": {"kind": "markdown", "value": "\n`make(~length, init)` creates an array of length `length` initialized with the value of `init`.\n\n## Examples\n\n```rescript\nArray.make(~length=3, #apple)->assertEqual([#apple, #apple, #apple])\nArray.make(~length=6, 7)->assertEqual([7, 7, 7, 7, 7, 7])\n```\n"}
617617
}, {
618618
"label": "map",
619619
"kind": 12,

yarn.config.cjs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,17 @@ async function enforceCompilerMeta({ Yarn }) {
5151
if (process.argv.includes("--fix")) {
5252
await fs.writeFile(
5353
compilerVersionFile,
54-
versionFile.replace(versionPattern, `let version = "${EXPECTED_VERSION}"`)
54+
versionFile.replace(
55+
versionPattern,
56+
`let version = "${EXPECTED_VERSION}"`,
57+
),
5558
);
5659
} else {
5760
const versionMatch = versionFile.match(versionPattern);
5861
const foundVersion = versionMatch?.groups?.version;
5962
if (foundVersion !== EXPECTED_VERSION) {
6063
Yarn.workspace().error(
61-
`compiler/common/bs_version.ml file need to be fixed; expected ${EXPECTED_VERSION}, found ${foundVersion}.`
64+
`compiler/common/bs_version.ml file need to be fixed; expected ${EXPECTED_VERSION}, found ${foundVersion}.`,
6265
);
6366
}
6467
}

0 commit comments

Comments
 (0)