mojo icon indicating copy to clipboard operation
mojo copied to clipboard

Published 20 hours ago • verified publisher icon modularml

[Docs] Constraints documentations need to be repeated for overloaded methods

Open ehsanmok opened this issue 10 months ago • 3 comments

Where is the problem?

https://github.com/modularml/mojo/blob/a8f7393a0e1e3e0a307391b844e1f00e9c4a05d9/stdlib/src/memory/unsafe.mojo#L60-L255

What can we do better?

Right now, overloaded methods that delegate to one another do not repeat the constraints in the docstring. This provides confusion to users who are looking at the one(s) that doesn't have the constraints documented. One such instance is bitcast where there are missing constraints in the some of the docstring.

Anything else?

No response

ehsanmok avatar Apr 08 '24 04:04 ehsanmok

Hi, Can I get this issue ?

Musa-Sina-Ertugrul avatar Apr 13 '24 06:04 Musa-Sina-Ertugrul

I opened PR #2280

Musa-Sina-Ertugrul avatar Apr 13 '24 11:04 Musa-Sina-Ertugrul

@Musa-Sina-Ertugrul are you still working on it? The previous PR was closed.

ehsanmok avatar Apr 22 '24 21:04 ehsanmok