Skip to content

[core][Matrix][Docs] Improve Matrix docstrings #287

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
Draft
wants to merge 246 commits into
base: pre-0.8
Choose a base branch
from
Draft

[core][Matrix][Docs] Improve Matrix docstrings #287

wants to merge 246 commits into from

Conversation

@shivasankarka
Copy link
Collaborator

@shivasankarka shivasankarka commented Nov 21, 2025

This PR improves the docstrings in matrix.mojo by adding clear explanations for all variables, methods and adding examples. It also standardizes the format of the docstring.

shivasankarka and others added 30 commits March 10, 2025 18:04
@shivasankarka
removed some typos
e9b6db3
@shivasankarka
fix typos in example
d589b50
@shivasankarka
Merge remote-tracking branch 'upstream/pre-0.7'
4f11dc3
@forfudan
[release] Merge pre-0.7 into main for the release of v0.7.0 (Mojo-Num…
2b72ef4 
…erics-and-Algorithms-group#251)

As title.
@shivasankarka
Merge remote-tracking branch 'upstream/main'
25c7796
@shivasankarka
updated to Mojo 25.4
3c3d5a3
@shivasankarka
update to Mojo 25.4
abd4fe8
@shivasankarka
update dependancies
6d46d59
@shivasankarka
fix format
533aa02
@shivasankarka
fix tests
a08b1a0
@shivasankarka
update to pixi
d52dbb7
@shivasankarka
fix github workflow
1e1f29a
@shivasankarka
fix github workflow
74d9a92
@shivasankarka
fix workflow
5fcf486
@shivasankarka
hopefully this fix works
fe07a23
@shivasankarka
fix ndarry formatting issue
183e4fb
@shivasankarka
fix formatting workflow
8b51f18
@shivasankarka
please work - formatter
827e855
@shivasankarka
fix format workflow
d92a7e4
@forfudan
Fix pre-commit issues
5bdca62
@forfudan
Update workflow
4c3ee57
@forfudan
Update workflow
bfc04a8
@shivasankarka
add load and save functions to io routines; update imports accordingly
e00ba89
@shivasankarka
Merge remote-tracking branch 'upstream/pre-0.8' into prev0.8
af116e9
@shivasankarka
added error types
a959745
@shivasankarka
updated file io methods
0a265ca
@shivasankarka
resolved name clashes.
03906cb
@shivasankarka
fix format
cbb8be9
@shivasankarka
fixed io errors
f8cf4d2
@shivasankarka
fix implicity conformance
b6099b7
@shivasankarka
fix LegacyUnsafePointer imports temporarily for NDArray related structs
4d6ef4e 
until we implement views for NDArray.
@shivasankarka
Update ndarray.mojo
5ce17dc
@shivasankarka
fix all __getitem__ and __setitem__ in Matrix to return and set views
be1d0ed 
and original instances.
@shivasankarka
fix matrix aliases, fix matrix arithmetics and logical operation
5c92ff1 
functions.
@shivasankarka
Update data_container.mojo
8dc4f29
@shivasankarka
setup basic iterator for matrix (dangling pointer)
fbcc09b
@shivasankarka
fix all other methods in the Matrix struct to work with views.
0aafb6f
@shivasankarka
correct the MatrixImpl and Matrix arguments and return types
3e368e5
@shivasankarka
fix origin errors in DataContainerNew
3ad2e8f
@shivasankarka
implement the correct iterator method for Matrix. The new matrix
ecbb339 
iterator returns mutable views.
@shivasankarka
the new matrix iterator returns mutable views with correct origins.
262ff76
@shivasankarka
add explanatory docstrings for the new aliases of MatrixImpl type
894911b
@shivasankarka
remove debug prints, rewrite some docstrings in matrix
808d2d6
@shivasankarka
Wrap long lines in MatrixImpl
86445cd
@shivasankarka
add a create_copy() method to create deep copies.
7deb3d5
@shivasankarka
pin modular nightly version for correct v0.25.7 testing
2cc3a40
@shivasankarka
fix some tests
2e8c9e0
@shivasankarka
fix format
5225844
@shivasankarka
track pixi lock file
7f0ca4f
@shivasankarka
update Mojo to 25.7.0
2402acf
@shivasankarka
temporarily comment out gt, lt checks of matrix in test_matrix
e1b20c6
@shivasankarka
remove lifetime extenders in test_matrix
06c2b51
@shivasankarka
fix all constructor docs
005c749
@shivasankarka
fix all getitem and setiitem docs
8fa51e1
@shivasankarka
rewrite all docstrings in matrix
a30bcc2
@shivasankarka
add examples to all methods in MatrixImpl
2a6353a
@shivasankarka shivasankarka marked this pull request as draft November 21, 2025 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@shivasankarka @forfudan