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.

Sign up for GitHub

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

Markdown Docstrings #28

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Markdown Docstrings #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b49100
Merge pull request #1 from Lomand/rescript-11-support
Lomand Nov 3, 2023
1717e88
Merge branch 'darklang:main' into main
Lomand Jan 3, 2024
27c626f
docstrings WIP
Lomand Nov 11, 2023
3ae96e2
Markdown docstrings (Rescript 11)
Lomand Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions src/Tablecloth.res
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
@ocaml.doc(" Functions for working with boolean ([true] or [false]) values. ")
/** Functions for working with boolean ([true] or [false]) values. */
module Bool = TableclothBool

@ocaml.doc(" Functions for working with single characters. ")
/** Functions for working with single characters. */
module Char = TableclothChar

@ocaml.doc(" Functions for working with [\"strings\"] ")
/** Functions for working with ["strings"] */
module String = TableclothString

@ocaml.doc(" Fixed precision integers ")
/** Fixed precision integers */
module Int = TableclothInt

@ocaml.doc(" Functions for working with floating point numbers. ")
/** Functions for working with floating point numbers. */
module Float = TableclothFloat

@ocaml.doc(" Interfaces for use with container types like {!Array} or {!List} ")
/** Interfaces for use with container types like [Array](Array.mdx#) or [List](List.mdx#) */
module Container = TableclothContainer

@ocaml.doc(" A fixed lenfth collection of values ")
/** A fixed lenfth collection of values */
module Array = TableclothArray

@ocaml.doc(" Arbitrary length, singly linked lists ")
/** Arbitrary length, singly linked lists */
module List = TableclothList

@ocaml.doc(" Functions for working with optional values. ")
/** Functions for working with optional values. */
module Option = TableclothOption

@ocaml.doc(" Functions for working with computations which may fail. ")
/** Functions for working with computations which may fail. */
module Result = TableclothResult

@ocaml.doc(" Functions for manipulating tuples of length two ")
/** Functions for manipulating tuples of length two */
module Tuple2 = TableclothTuple2

@ocaml.doc(" Functions for manipulating tuples of length three ")
/** Functions for manipulating tuples of length three */
module Tuple3 = TableclothTuple3

module Comparator = TableclothComparator

@ocaml.doc(" A collection of unique values ")
/** A collection of unique values */
module Set = TableclothSet

@ocaml.doc(" A collection of key-value pairs ")
/** A collection of key-value pairs */
module Map = TableclothMap

@ocaml.doc(" Functions for working with functions. ")
/** Functions for working with functions. */
module Fun = TableclothFun
Loading