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

[Utils] Remove doc string scripts #2118

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Conversation

JoeLoser
Copy link
Collaborator

@JoeLoser JoeLoser commented Apr 1, 2024

These doc strings scripts for doing API doc string validation don't yet work. Remove them for now to avoid any confusion for other contributors.

These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
@JoeLoser JoeLoser requested a review from a team as a code owner April 1, 2024 23:57
@JoeLoser JoeLoser merged commit b58f12d into modularml:nightly Apr 2, 2024
2 checks passed
StandinKP pushed a commit to StandinKP/mojo that referenced this pull request Apr 2, 2024
These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
mzaks pushed a commit to mzaks/mojo that referenced this pull request Apr 2, 2024
These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
mzaks pushed a commit to mzaks/mojo that referenced this pull request Apr 2, 2024
These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
mzaks pushed a commit to mzaks/mojo that referenced this pull request Apr 2, 2024
These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
mzaks pushed a commit to mzaks/mojo that referenced this pull request Apr 2, 2024
…ce` (modularml#2035)

Replace most uses of `__get_lvalue_as_address` with `Reference`.  The two remaining uses at `memory/anypointer.mojo` and `memory/unsafe.mojo` can't switch over to using `Reference` since register passable things don't carry a lifetime value (and thus cannot be used with `Reference`).  They are current rejected by the compiler with the error:

```mojo
error: cannot form a reference to an argument that might instantiate to @register_passable type
```

Fixes modularml#2027.

Signed-off-by: Shaikh Ubaid <shaikhubaid769@gmail.com> (+19 squashed commits)
Squashed commits:
[64928ee] [Utils] Remove doc string scripts (modularml#2118)

These doc strings scripts for doing API doc string validation don't yet work.
Remove them for now to avoid any confusion for other contributors.
[d0b6eae] [stdlib] Use variadic initializer for `List` in tests (modularml#2074)

Update the tests to make use of the variadic initializer of `List`.

Signed-off-by: Mert Celik <otuz.bes.bucuk@hotmail.com>
[3eb5d13] [stdlib] Add `String.removeprefix` and `String.removesuffix` (modularml#2038)

The two methods `removeprefix` and `removesuffix` are present in python. See the docs:
* https://docs.python.org/3/library/stdtypes.html#str.removeprefix
* https://docs.python.org/3/library/stdtypes.html#str.removesuffix

Both were introduced in python 3.9.

The documentation was added, the arguments were made positional-only like in CPython.  Unit tests were added in the corresponding module. The docstrings were taken from the python documentation.

Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
[9a18569] [stdlib] Check compiler versions before building

There's often breaking changes in the compiler that mandate an update to the
latest `nightly/mojo` compiler in order to work with the latest standard
library.  Currently, if a user installs a newer `nightly/mojo` compiler but
hasn't updated the library source code, they'll get pages of bad errors
depending on the breaking change, often "cryptic" MLIR errors.  This is not a
great user experience, and does not tell contributors what they can/should do.

To improve this user experience, check the current installed compiler version
in the script when building the standard library.  If there is a mismatch
between the expected compiler version (stored in a file in the repo) and the
installed compiler, give a good error message telling the user to update their
`nightly/mojo` compiler.

Note:
- An alternative approach is to query to find the "latest compiler version
  released" and check against that, but that has the caveat that just because
  internally we publish a new `nightly/mojo` package, if someone hasn't updated
  their local copy of the standard library source code, they shouldn't be
  prevented from building just because something out-of-band changed/got
  updated.  This approach keeps the local flow working until they update their
  copy of the library source code.
- We'll probably want to rewrite these bash scripts into Python for a bit better
  maintenance soon.
[ffb784d] [mojo-lang] Expand `VariadicPack` to take parametric trait base (#36319)

This patch is a big step towards enabling VariadicPack to model
packs with a non-AnyType bound (e.g. all members must be Stringable).
It expands `VariadicPack` with a new `element_trait` member that
indicates what all the elements are, and teaches the parser to
pass down the element type.

The magic enabling this is support for metatype bound type
expressions which is almost working, but not quite there yet. As
such, this is another step, but isn't enough to declare success,
which is why the integration test isn't using it yet. :-/

modular-orig-commit: d45b597eef0f58fc20770c2b7ec860216e9ecc6c
[400acec] [mojo][repl] Fix erroneous destructor call emission in generated REPL source (#35595)

The REPL is doing dirty tricks with variables, turning them into heap
allocations and tracking them in indirect structs. However,
CheckLifetimes
is onto its tricks, which causes it to reject these as incorrect values.

The right solution is to make more invasive changes to the REPL, but
that isn't in the short term plans.  Workaround this by introducing a
horrible hack (tm) op `RefFromPointerUntrackedOp` that creates a
reference that isn't tracked by CheckLifetimes.

This pokes a hole in our nice reference system which makes me very
sad.  A comment saying "don't use this" will prevent other people from
using this for other things ... right???

---------

Co-authored-by: Chris Lattner <clattner@nondot.org>

modular-orig-commit: 7a6b7339522d2657f72d7e8a3a5b51e4d299167f
[55c27f3] [mojo-stdlib] Move DTypePointer inits to `inout Self` (#36262)

This is split off of #33595

modular-orig-commit: d745e5673d768ab862661f0ada2adb91f34e81e2
[bdc32af] [Internal Change]

modular-orig-commit: 44d3a3560edfbd4510e7a906d895a5b01c04b606
[0ecd8f1] [docs] Cross-link the vision and roadmap docs (#36142)

Maybe that wasn't the doc you were looking for.

modular-orig-commit: fb7d62c22be4e0edf05c49e4624c9fa4a1f880f8
[e79c05c] [CHANGELOG] Update for `mojo build` change (#36210)

Update the changelog to reflect #36207, since it represents a slight
change in the `mojo` tool's behavior.

modular-orig-commit: 0e954f4d4768c3674dfd4f8989f67050bec140cf
[3a46831] [mojo-examples] Fix incorrect logic in vectorize loop (#36196)

The logic was incorrect if there was a remainder from C.cols % nelts

modular-orig-commit: 347157c2401cdacd24f97f1a42027245438e168d
[2579983] [Stdlib] Reconcile the div_ceil and ceildiv functions (#36203)

We only need a single one of these, so just remove the div_ceil function
in place of the ceildiv one (since the ceildiv is what it's called in
Python).

Closes #33323

modular-orig-commit: 627e5eef1aa20d7c03f0330ad608b2dbbe24a945
[423d7ea] [mojo-driver] Add a `-g` option that aliases `--debug-level full` (#36069)

This provides a more familiar way to enable full debugging that
matches many other languages.

Closes #24171

modular-orig-commit: 7d9038b935bbf86b775237a33b0cb294798200af
[6c5b7f7] [mojo-stdlib] Remove always_inline from debug_assert (#36065)

This was required originally because of issues related to packaging,
but with the removal of separate package codegen, this is no longer
necessary.

Closes #24957

modular-orig-commit: 79be2c2c74f2aefac95625115a8b7baf291c25ad
[c829aad] [mojo] Error out on defining `main` in a package (#36062)

The semantics of this are not well defined for mojo right now,
so it's cleaner to just disallow it. We can loosen this up when
we have cleaner semantics around entry points in packages.

Closes [Internal Link]

modular-orig-commit: 3203283b41bfd984cd183ba1a314c0c3ba13925d
[5d0bd69] [mojo-lang] Change mlir-ification of values of trait type. (#36166)

This changes substituteMLIRMagic to include the trait type in the
expanded string for a value of trait type in a KGEN type context.
This makes it easier and less error prone to work with trait values.

If there is a reason to get the raw type without a preceding type,
then you can use the unary plus hack like for other attribute values.

modular-orig-commit: 09c8a037b73d016d139e8391bb37d31c943ed9b4
[b694374] [mojo-stdlib] Move a few more regpassable inits to 'inout self'. (#36150)

This just cleans up a few more of these in builtin_list.

modular-orig-commit: 0f88978e8005a0e0aae4c2e279b57cbca8b101c7
[1fe6968] [Docs] Update load()/store() item and move it to top of removed section. (#36110)

modular-orig-commit: 038e34dca15cff2a2bdb22285f6d90628737a66d
[915e71e] Fix small typo time.mojo (modularml#2067)

* Update time.mojo

* Update time.mojo
patrickdoc added a commit to patrickdoc/mojo that referenced this pull request May 2, 2024
These doc strings scripts for doing API doc string validation don't yet
work. Remove them for now to avoid any confusion for other contributors.

mojo-orig-commit: b58f12d

Co-authored-by: Joe Loser <joe@modular.com>
MODULAR_ORIG_COMMIT_REV_ID: eda17f7b1f6cb4a57a992d4921a207f40ac58482
patrickdoc added a commit that referenced this pull request May 2, 2024
These doc strings scripts for doing API doc string validation don't yet
work. Remove them for now to avoid any confusion for other contributors.

mojo-orig-commit: b58f12d

Co-authored-by: Joe Loser <joe@modular.com>
MODULAR_ORIG_COMMIT_REV_ID: eda17f7b1f6cb4a57a992d4921a207f40ac58482
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.

None yet

2 participants