Skip to content

Commit

Permalink
[mojo-stdlib][docs] Minor doc edits for packages (#35577)
Browse files Browse the repository at this point in the history
Some minor doc edits I noticed when comparing the staged site of docs
vs. last release as some things have moved around. While here, update the
changelog for `parallel_memcpy` being *moved*, not *removed* from the standard
library.

modular-orig-commit: f3a53c28b5db3b7477a0675b2df4bd632cde5eb3
  • Loading branch information
JoeLoser authored Mar 23, 2024
1 parent a98f6da commit 90b8c5d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 9 deletions.
14 changes: 7 additions & 7 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ modular update mojo
fn var_kwparams[**kwparams: Int](): ...
```
- Added new `collections.OptionalReg` type, a register-passable alternative
to `Optional`.
- Added new `collections.OptionalReg` type, a register-passable alternative
to `Optional`.
### 🦋 Changed
Expand Down Expand Up @@ -231,9 +231,11 @@ modular update mojo
- `rand` and `randn` functions in the `random` package that return a `Tensor`
have moved to the `tensor` package.
- `Buffer`, `NDBuffer`, and friends have moved from the `memory` package
into a new `buffer` package.
into a new `buffer` package.
- The `trap` function has been renamed to `abort`. It also has moved from the
`debug` module to the `os` module.
- `parallel_memcpy` has moved from the `memory` package into
the `buffer` package.

### ❌ Removed

Expand All @@ -255,10 +257,8 @@ modular update mojo
- `memcpy` on `Buffer` has been removed in favor of just overloads for `Pointer`
and `DTypePointer`.

- `parallel_memcpy` has been removed from the Standard Library for now.

- The functions `max_or_inf`, `min_or_neginf` have been removed from
`math.limit` and just inlined into their use in SIMD.
- The functions `max_or_inf`, `min_or_neginf` have been removed from
`math.limit` and just inlined into their use in SIMD.

### 🛠️ Fixed

Expand Down
2 changes: 2 additions & 0 deletions stdlib/src/testing/__init__.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
# limitations under the License.
# ===----------------------------------------------------------------------=== #

"""Implements the testing package."""

from .testing import (
assert_true,
assert_false,
Expand Down
4 changes: 4 additions & 0 deletions stdlib/src/utils/small_string.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
# limitations under the License.
# ===----------------------------------------------------------------------=== #

"""Implements a string that has a small-string optimization which
avoids heap allocations for short strings.
"""

from sys.info import sizeof

from memory import memcpy
Expand Down
2 changes: 0 additions & 2 deletions stdlib/src/utils/stringref.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
# limitations under the License.
# ===----------------------------------------------------------------------=== #
"""Implements the StringRef class.
These are Mojo built-ins, so you don't need to import them.
"""


Expand Down

0 comments on commit 90b8c5d

Please sign in to comment.