Skip to content

Commit 3506f62

Browse files
committed
Consistently capitalize TypeScript in README
1 parent c386e0e commit 3506f62

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -442,10 +442,10 @@ or ``js:class`` and use the class's full (but dotted) path when you do::
442442
Unfortunately, Sphinx's ``~`` syntax doesn't work in these spots, so users will
443443
see the full paths in the documentation.
444444

445-
Typescript: Cross references
445+
TypeScript: Cross references
446446
----------------------------
447447

448-
Typescript types will be converted to cross references. To render cross
448+
TypeScript types will be converted to cross references. To render cross
449449
references, you can define a hook in ``conf.py`` called ``ts_type_xref_formatter``. It
450450
should take two arguments: the first argument is the sphinx confix, and the
451451
second is an ``sphinx_js.ir.TypeXRef`` object. This has a ``name`` field and two
@@ -495,19 +495,19 @@ Configuration Reference
495495
If using TypeDoc, specify the path of ``tsconfig.json`` file
496496

497497
``ts_type_xref_formatter``
498-
A function for formatting typescript type cross references. See the
499-
"Typescript: Cross references" section below.
498+
A function for formatting TypeScript type cross references. See the
499+
"TypeScript: Cross references" section below.
500500

501501
``ts_type_bold``
502-
Make all typescript types bold if ``true``.
502+
Make all TypeScript types bold if ``true``.
503503

504504
``ts_sphinx_js_config``
505-
A link to a typescript config file.
505+
A link to a TypeScript config file.
506506

507507
The ``ts_sphinx_js_config`` file
508508
------------------------------
509509

510-
This file should be a typescript module. It's executed in a context where it can
510+
This file should be a TypeScript module. It's executed in a context where it can
511511
import ``typedoc`` and ``sphinx_js``. These functions take TypeDoc IR objects as
512512
arguments. Since the TypeDoc IR is unstable, this config may often break when
513513
switching TypeDoc versions. However, these hooks are very powerful so using them
@@ -534,7 +534,7 @@ functions::
534534
* ``preConvert?: (app: Application) => Promise<void>;``
535535

536536
This hook is called with the TypeDoc application as argument before the
537-
typescript files are parsed. For example, it can be used to add extra TypeDoc
537+
TypeScript files are parsed. For example, it can be used to add extra TypeDoc
538538
plugins.
539539

540540
* ``postConvert: (app: Application, project: ProjectReflection, typeDocToIRMap: Map<DeclarationReflection, TopLevelIR>) => void``
@@ -603,7 +603,7 @@ documentation. A particularly juicy page is
603603
`<https://mozilla.github.io/fathom/ruleset.html>`__. Click the "View page
604604
source" link to see the raw directives.
605605

606-
For a typescript example, see `the Pyodide api docs
606+
For a TypeScript example, see `the Pyodide api docs
607607
<https://pyodide.org/en/stable/usage/api/js-api.html>`__.
608608

609609
`ReadTheDocs <https://readthedocs.org/>`__ is the canonical hosting platform for
@@ -661,7 +661,7 @@ Version History
661661
pyodide/sphinx-js-fork#54, pyodide/sphinx-js-fork#174,
662662
#266
663663
)
664-
* Added handling for Typescript type parameters and type bounds.
664+
* Added handling for TypeScript type parameters and type bounds.
665665
(pyodide/sphinx-js-fork#25)
666666
* Only monkeypatch Sphinx classes when sphinx_js extension is used
667667
(pyodide/sphinx-js-fork#27)
@@ -670,17 +670,17 @@ Version History
670670
* Handle markdown style codepens correctly in typedoc comments.
671671
(pyodide/sphinx-js-fork#47)
672672
* Added support for destructuring the documentation of keyword arguments in
673-
Typescript using the ``@destructure`` tag or the
673+
TypeScript using the ``@destructure`` tag or the
674674
``shouldDestructureArg`` hook.
675675
(pyodide/sphinx-js-fork#48, pyodide/sphinx-js-fork#74,
676676
pyodide/sphinx-js-fork#75, pyodide/sphinx-js-fork#101,
677677
pyodide/sphinx-js-fork#128)
678-
* Added rendering for cross references in Typescript types.
678+
* Added rendering for cross references in TypeScript types.
679679
(pyodide/sphinx-js-fork#51, pyodide/sphinx-js-fork#56,
680680
pyodide/sphinx-js-fork#67, pyodide/sphinx-js-fork#81,
681681
pyodide/sphinx-js-fork#82, pyodide/sphinx-js-fork#83,
682682
pyodide/sphinx-js-fork#153, pyodide/sphinx-js-fork#160)
683-
* Added rendering for function types in Typescript documentation.
683+
* Added rendering for function types in TypeScript documentation.
684684
(pyodide/sphinx-js-fork#55, pyodide/sphinx-js-fork#58,
685685
pyodide/sphinx-js-fork#59)
686686
* Add async prefix to async functions (pyodide/sphinx-js-fork#65).

0 commit comments

Comments
 (0)