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

Jump to bottom

Create values and functions tutorial #1512

Merged
merged 95 commits into from Nov 10, 2023
Merged

Create values and functions tutorial #1512

merged 95 commits into from Nov 10, 2023

Conversation

cuihtlauac
Copy link
Collaborator

@cuihtlauac cuihtlauac commented Aug 25, 2023 •
edited

This is an intermediate level tutorial.

The main goal is to master the concepts of definition, scope and environment. It covers definitions of functional and non-functional values.

https://staging.ocaml.org/docs/values-and-functions

cuihtlauac pushed a commit that referenced this pull request Aug 28, 2023
Create values and functions tutorial #1512
18a33a3
sabine added a commit that referenced this pull request Aug 29, 2023
@sabine
Create values and functions tutorial #1512 (18a33a3)
3fb2b96
christinerose
christinerose reviewed Aug 30, 2023
View reviewed changes
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
cuihtlauac pushed a commit that referenced this pull request Sep 4, 2023
Update Create values and functions tutorial #1512 (473568a)
49ba318
christinerose
christinerose reviewed Sep 5, 2023
View reviewed changes
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_09_env.md Outdated Show resolved Hide resolved
data/tutorials/language/0lg_08_env.md Outdated Show resolved Hide resolved
christinerose
christinerose reviewed Sep 5, 2023
View reviewed changes
Copy link
Collaborator

@christinerose christinerose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few new comments/suggestions and a few that were outdated from before (just in case they were lost in the shuffle). If you didn't want to make those changes or it didn't clarify, we can work on them together if necessary.

cuihtlauac pushed a commit that referenced this pull request Sep 6, 2023
Update PR #1512 and #1514
d16550c
cuihtlauac pushed a commit that referenced this pull request Sep 6, 2023
Update PR #1512
d2a2609
sabine added a commit that referenced this pull request Sep 7, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
46e5e78
sabine added a commit that referenced this pull request Sep 7, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
542a3f1
sabine added a commit that referenced this pull request Sep 7, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
92af43a
lindig
lindig reviewed Sep 12, 2023
View reviewed changes
data/tutorials/language/0lg_09_env.md Outdated

### Values

Like most functional programming languages, OCaml is an [expression-oriented programming language](https://en.wikipedia.org/wiki/Expression-oriented_programming_language). There are no [statements](https://en.wikipedia.org/wiki/Statement_(computer_science)), i.e., syntactical constructions made to produce some change of state. Variable [assignments](https://en.wikipedia.org/wiki/Assignment_(computer_science)) or [for loop](https://en.wikipedia.org/wiki/For_loop) are examples of statements. Computations triggered by OCaml are written as expressions. Once completed, they produce a value, which has a type. Here are a few examples of expressions, their type, and resulting values.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would phrase the difference between expressions and statements this way: the evaluation of a an expression yields a value, the evaluation of a statement yields an effect, i.e. a change of state. In many languages expressions can still yield effects and so the distinction between is not always clear cut. The same is true in OCaml where expressions and effects can be mixed.

@sabine sabine linked an issue Sep 15, 2023 that may be closed by this pull request
Functions and Values #1425
Closed
sabine added a commit that referenced this pull request Oct 5, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
5935126
sabine added a commit that referenced this pull request Oct 5, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
61a0ff5
sabine added a commit that referenced this pull request Oct 9, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
dcd041d
sabine added a commit that referenced this pull request Oct 10, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
e0ae2b0
sabine added a commit that referenced this pull request Oct 12, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
ea9c8d9
sabine added a commit that referenced this pull request Oct 12, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
c6ffc5b
sabine added a commit that referenced this pull request Oct 16, 2023
@sabine
Create values and functions tutorial #1512 (487aa8b)
0c3a397
@christinerose christinerose self-requested a review October 17, 2023 06:43
Cuihtlauac ALVARADO and others added 22 commits November 9, 2023 15:56
Remove unintended shadowing
591c55f
Remove unintended shadowing, cont'd
16d966b
Minor edits
c93fc5d
@cuihtlauac @christinerose
Apply suggestions from code review
1d2b216 
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
@cuihtlauac @christinerose
Apply suggestions from code review
c405664 
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
@cuihtlauac @christinerose
Apply suggestions from code review
a7b8605 
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
@christinerose
minor corrections
9c7c11f
@cuihtlauac @christinerose
Apply suggestions from code review
ac7113d 
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Minor edits
8c0a25f
More edits
88ccb99
More edits, cont'd
0cd7dd9
@christinerose
Apply suggestions from code review
36f0a29
Another batch of edits
51bccb7
Fix conclusion
c0202a3
More edits
fcff203
@christinerose
Update data/tutorials/language/0lg_09_env.md
fe2af3c
@christinerose
formatting note
e42a6c3
@christinerose
clarify domain & codomain
bf7267a
@christinerose
Further clarification of domain/codomain
a1b83a2
Edits
c9174ea
Rename file to prepare publication
483bb74
Rename files to prepare publication
730827e
@cuihtlauac cuihtlauac merged commit 13d2dde into main Nov 10, 2023
3 checks passed
@cuihtlauac cuihtlauac deleted the doc-env branch November 10, 2023 10:32
cuihtlauac pushed a commit that referenced this pull request Nov 10, 2023
Revert "Create values and functions tutorial (#1512)"
1004f5c 
This reverts commit 13d2dde.
@cuihtlauac cuihtlauac mentioned this pull request Nov 10, 2023
Merged
@tmattio tmattio mentioned this pull request Nov 10, 2023
Merged
cuihtlauac added a commit that referenced this pull request Nov 15, 2023
@cuihtlauac @christinerose @sabine
Create values and functions tutorial (#1512)
6669c10 
This is the first tutorial after “Get Started”

This tutorial introduces basic data types in OCaml. Its goal is to teach skills on how to handle data from predefined, variant, and record types. It also includes the important concept of pattern matching on those types.

Outline:

1. Predefined Types
    1.1. Integers, Floats, Booleans, and Characters
    1.2. Strings & Byte Sequences
    1.3. Arrays & Lists
    1.4. Options & Results
    1.5. Tuples
    1.6. Functions
    1.7. Unit
2. User-Defined Types
    2.1. Variants
    2.2. Polymorphic Data Types
    2.3. Records
    2.4. Type Aliases
3.  A Complete Example: Mathematical Expressions


---------

Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Co-authored-by: sabine <sabine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lindig lindig lindig left review comments

@sabine sabine sabine left review comments

@christinerose christinerose christinerose approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Functions and Values
4 participants
@cuihtlauac @lindig @sabine @christinerose