Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates typedoc syntax to address warnings #733

Merged
merged 1 commit into from Nov 28, 2022

Conversation

zslayton
Copy link
Contributor

  • Adds code fences (triple backticks) around example code in each doc comment.
  • Replaces obsolete [[Name]] link usages with {@link Name}.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

* Adds code fences (triple backticks) around example code in
  each doc comment.
* Replaces obsolete `[[Name]]` link usages with `{@link Name}`.
@zslayton
Copy link
Contributor Author

The ion-test-driver failure appears to be an issue with running the CLI and not a correctness problem introduced by updating our doc comment syntax. @cheqianh is investigating; I'm going to go ahead and merge this in the meantime.

@zslayton zslayton merged commit 6d3a947 into v5.0.0-development Nov 28, 2022
@zslayton zslayton deleted the update-typedoc-comments branch November 28, 2022 18:40
@cheqianh
Copy link
Contributor

cheqianh commented Nov 28, 2022

A quick update,

The test-driver consistently complained with the error message subprocess.CalledProcessError: Command '('npm', 'run-script', 'build-test-driver')' returned non-zero exit status 3 (still failed after few re-attempts).

It does not because of the PR change but about how the ion-test-driver invokes JS script. I'll reproduce it locally next but feel free to merge it first.

@cheqianh cheqianh mentioned this pull request Nov 29, 2022
desaikd added a commit that referenced this pull request Apr 24, 2023
* Drops support for Node 10.x, 12.x and adds 18.x (#723)

* move to native `BigInt` from `JSBI` (#721)

* Updates typedoc syntax to address warnings (#733)

* updates test-driver to es2020 (#736)

* Migrate linting from TSLint to ESLint (#737)

* adds changes for resolving ion-test-driver build issue (#748)

* adds changes to allow `dom.Decimal` construction from `Number` and `String` (#746)

* updates uglify version

* adds changes for upconverting JS value for dom collections (#749)

* removes deprecated method `byteValue()` for v5.0.0 release (#750)

* modifies `Struct#elements()` to return all field values (#754)

---------

Co-authored-by: Matthew Pope <81593196+popematt@users.noreply.github.com>
Co-authored-by: Delaney <delaneygillilan@gmail.com>
Co-authored-by: Zack Slayton <zack.slayton@gmail.com>
Co-authored-by: Andrey Lipatkin <400234+Litee@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants