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

Update Capture sections in expressions.md #987

Merged
merged 3 commits into from
Feb 25, 2024

Conversation

bluetarpmedia
Copy link
Contributor

  • Fix small typo (Depending on...)
  • Small tweaks to wording
  • Moved the design and syntax note up into the main Capture section rather than under the Function Expression section
  • Show output of the Function Expression example
  • Add a second example to the Function Expression section to demonstrate the behaviour after mutating the captured variable

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
@bluetarpmedia bluetarpmedia changed the title Update expressions.md Update Capture sections in expressions.md Feb 20, 2024
And a couple of other fixes, including that I meant to write "ish" not "sh" (fixing my own typo!)
Signed-off-by: Herb Sutter <herb.sutter@gmail.com>
@hsutter hsutter merged commit 8d49525 into hsutter:docs Feb 25, 2024
@hsutter
Copy link
Owner

hsutter commented Feb 25, 2024

Thanks!

hsutter added a commit that referenced this pull request Mar 11, 2024
* Initial files to test MkDocs with Material

* Update checkout version

* Trying checkout with no version

* Back to v3

* Try renaming to docs

* Test push to renamed docs branch

* Try moving mkdocs.yml to root to unblock CI

* Further cleanup to get things in the right directories

* Finish moving from `/docs/docs` to `/docs`

Added local hosting instructions in the YAML file

This renders beautifully locally, but for some reason it doesn't render properly on GitHub Pages yet. One possible reason is the `pages-build-deployment` workflow that GitHub Pages created on my initial attempt to use Pages (before trying MkDocs) is still running (and I can't figure out how to get rid of it) and it appears to be interfering with the `docs` workflow I created for MkDocs

If someone has ideas on how to debug this, please open an issue or email me - thx!

* Add "Cppfront reference," and start writing "Cpp2 reference"

* Merged documentation from blog posts, and unary operators

`_` wildcard, including in `inspect` and explicit discard

Named `break` and `continue`

`type` declaration syntax

Explicit `this`

`operator=`

Chained comparisons

Metafunctions overview

`@enum` and `@flag_enum`

`@union`

* Integrate links to wiki design notes

* Add more sections

Type qualifiers
Binary operators
`is`
and update chained comparisons

* Add `as` and `inspect`

* Document declarations, improve `inspect` discussion

* Fix a few typos

* Add Hello-world xref

* Update mkdocs.yml

* Improve mixed files examples and flow

* Overview editorial improvements

* Minor cleanup

* docs: fix some typos and confusing wording (#976)

* docs: fix some typos and confusing wording

* restore std::ssize

* Fix table of content display -> rhs of page

* Add section navigation

Reorganize sources

Fix long code lines to avoid horizontal scroll bars

* Organize the welcome info into three pages

And try to use extra CSS to tweak the navigation pane

* Disable regression tests on this branch

* Add more types and `operator=` material

And do further cleanup on the docs structure

* Add keywords, objects, and heap allocation

* Add `main`

* Reviewing cppfront docs (#982)

* Reviewing cppfront docs

* integrations.md

* expressions and objects

* Fix "lines 8, 9, and 15" wording

* Mention UFCS

* Function outputs and explicit discard

* Add definite initialization section

And:
- add placeholder for contracts
- add some is/as side-by-side examples
- add parameter passing styles

* Update CTAD description in hello-world.md (#984)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Embiggen text font, add `move` and `out` arguments

And code block cleanup:
- highlight key lines in all code blocks
- remove redundant "Example:" in code block titles
- add a chained comparisons example

* Fix small typo in common.md (#985)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Changes to expressions.md (#986)

* Update expressions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Minor tweak to not lose "dynamic" types

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Another round of docs updates (#983)

* types

* metafunctions

* Taking a pass over the updates, and adding that `that` must be `in` or `move`

* Remove TODO comment for now

Not sure of its meaning, we can add again later

---------

Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Add syntax highlighting for inline code blocks using `#!cpp` shebangs

Note: I deliberately did not add shebangs for:
- `inline code` that wouldn't benefit from them (e.g., had nothing significant to highlight) so as to keep the Markdown more readable
- `inline code` that I didn't want to highlight, mainly Cpp2 code that used Cpp1 reserved keywords in a non-reserved way (mainly metafunctions like @enum and @union)

* Move function calls to expressions

* Add capture section

And add Cpp1 lowering notes for parameter passing

* Add Mermaid build diagram

* Add TODO for `member = _;`

* Add interpolation formatting, and other minor cleanup

* Expand comparisons section

Also add short anchor names to all subsections that don't already have them
And make anchor names all lowercase-like-this

* Update declarations.md (#988)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Follow up merge with additional examples, and update highlighted linenos

* Update Capture sections in expressions.md (#987)

* Update expressions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Update highlighted linenos

And a couple of other fixes, including that I meant to write "ish" not "sh" (fixing my own typo!)

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Signed-off-by: Herb Sutter <herb.sutter@gmail.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* More docs reviews (#990)

* Add more functions material

Return values
Branches
Loops
Template parameters

* Changes to functions.md (#998)

* Update functions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Tweak comments for divide example

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Fill in some TODO's

* Add requires, namespaces, using, and namespace/type/function/object aliases

* Update aliases.md (#1005)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Add generality notes: Function defaults, and function <-> block/stmt unification

* Merge previous commit

* Update functions.md (#1011)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Update declarations.md (#1010)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Complete the metafunctions section

* Update metafunctions.md (#1015)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Add contracts documentation

* Remove modules documentation stub since that's not supported yet

* Fix comment typo

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Signed-off-by: Herb Sutter <herb.sutter@gmail.com>
Co-authored-by: Dylam De La Torre <DyXel04@gmail.com>
Co-authored-by: gregmarr <gregmarr@users.noreply.github.com>
Co-authored-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
hsutter added a commit that referenced this pull request Mar 15, 2024
* Initial files to test MkDocs with Material

* Update checkout version

* Trying checkout with no version

* Back to v3

* Try renaming to docs

* Test push to renamed docs branch

* Try moving mkdocs.yml to root to unblock CI

* Further cleanup to get things in the right directories

* Finish moving from `/docs/docs` to `/docs`

Added local hosting instructions in the YAML file

This renders beautifully locally, but for some reason it doesn't render properly on GitHub Pages yet. One possible reason is the `pages-build-deployment` workflow that GitHub Pages created on my initial attempt to use Pages (before trying MkDocs) is still running (and I can't figure out how to get rid of it) and it appears to be interfering with the `docs` workflow I created for MkDocs

If someone has ideas on how to debug this, please open an issue or email me - thx!

* Add "Cppfront reference," and start writing "Cpp2 reference"

* Merged documentation from blog posts, and unary operators

`_` wildcard, including in `inspect` and explicit discard

Named `break` and `continue`

`type` declaration syntax

Explicit `this`

`operator=`

Chained comparisons

Metafunctions overview

`@enum` and `@flag_enum`

`@union`

* Integrate links to wiki design notes

* Add more sections

Type qualifiers
Binary operators
`is`
and update chained comparisons

* Add `as` and `inspect`

* Document declarations, improve `inspect` discussion

* Fix a few typos

* Add Hello-world xref

* Update mkdocs.yml

* Improve mixed files examples and flow

* Overview editorial improvements

* Minor cleanup

* docs: fix some typos and confusing wording (#976)

* docs: fix some typos and confusing wording

* restore std::ssize

* Fix table of content display -> rhs of page

* Add section navigation

Reorganize sources

Fix long code lines to avoid horizontal scroll bars

* Organize the welcome info into three pages

And try to use extra CSS to tweak the navigation pane

* Disable regression tests on this branch

* Add more types and `operator=` material

And do further cleanup on the docs structure

* Add keywords, objects, and heap allocation

* Add `main`

* Reviewing cppfront docs (#982)

* Reviewing cppfront docs

* integrations.md

* expressions and objects

* Fix "lines 8, 9, and 15" wording

* Mention UFCS

* Function outputs and explicit discard

* Add definite initialization section

And:
- add placeholder for contracts
- add some is/as side-by-side examples
- add parameter passing styles

* Update CTAD description in hello-world.md (#984)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Embiggen text font, add `move` and `out` arguments

And code block cleanup:
- highlight key lines in all code blocks
- remove redundant "Example:" in code block titles
- add a chained comparisons example

* Fix small typo in common.md (#985)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Changes to expressions.md (#986)

* Update expressions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Minor tweak to not lose "dynamic" types

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Another round of docs updates (#983)

* types

* metafunctions

* Taking a pass over the updates, and adding that `that` must be `in` or `move`

* Remove TODO comment for now

Not sure of its meaning, we can add again later

---------

Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Add syntax highlighting for inline code blocks using `#!cpp` shebangs

Note: I deliberately did not add shebangs for:
- `inline code` that wouldn't benefit from them (e.g., had nothing significant to highlight) so as to keep the Markdown more readable
- `inline code` that I didn't want to highlight, mainly Cpp2 code that used Cpp1 reserved keywords in a non-reserved way (mainly metafunctions like @enum and @union)

* Move function calls to expressions

* Add capture section

And add Cpp1 lowering notes for parameter passing

* Add Mermaid build diagram

* Add TODO for `member = _;`

* Add interpolation formatting, and other minor cleanup

* Expand comparisons section

Also add short anchor names to all subsections that don't already have them
And make anchor names all lowercase-like-this

* Update declarations.md (#988)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Follow up merge with additional examples, and update highlighted linenos

* Update Capture sections in expressions.md (#987)

* Update expressions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Update highlighted linenos

And a couple of other fixes, including that I meant to write "ish" not "sh" (fixing my own typo!)

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Signed-off-by: Herb Sutter <herb.sutter@gmail.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* More docs reviews (#990)

* Add more functions material

Return values
Branches
Loops
Template parameters

* Changes to functions.md (#998)

* Update functions.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Tweak comments for divide example

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>

* Fill in some TODO's

* Add requires, namespaces, using, and namespace/type/function/object aliases

* Update aliases.md (#1005)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Add generality notes: Function defaults, and function <-> block/stmt unification

* Merge previous commit

* Update functions.md (#1011)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Update declarations.md (#1010)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Complete the metafunctions section

* Update metafunctions.md (#1015)

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

* Add contracts documentation

* Remove modules documentation stub since that's not supported yet

* Fix comment typo

* Update contracts.md

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>

---------

Signed-off-by: Neil Henderson <2060747+bluetarpmedia@users.noreply.github.com>
Signed-off-by: Herb Sutter <herb.sutter@gmail.com>
Co-authored-by: Herb Sutter <herb.sutter@gmail.com>
Co-authored-by: Dylam De La Torre <DyXel04@gmail.com>
Co-authored-by: gregmarr <gregmarr@users.noreply.github.com>
@bluetarpmedia bluetarpmedia deleted the patch-4 branch March 20, 2024 03:52
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.

2 participants