Skip to content

Conversation

@shivasankarka
Copy link
Collaborator

@shivasankarka shivasankarka commented Feb 20, 2025

  1. This PR standardizes the Doctoring format according to Mojo docstring style guide (and to be aligned with numpy) which is as follows,
Description:
Parameters:
Args:
Returns:
Raises:
See Also:
Notes:
References
Examples:
  1. Add more descriptive errors in the internal functions of NDArray to give better understanding of the errors and also their source.

@shivasankarka shivasankarka changed the base branch from main to pre-0.6 February 20, 2025 08:56
@forfudan forfudan changed the title [update][NDArray] Update Doctoring format & Errors [doc][core][ndarray] Update Doctoring format & fix errors for NDArray Feb 20, 2025
@forfudan forfudan changed the title [doc][core][ndarray] Update Doctoring format & fix errors for NDArray [doc][core][ndarray] Update Doctoring format & errors for NDArray Feb 20, 2025
@forfudan
Copy link
Collaborator

@shivasankarka It is also related to Mojo docstring style guide. The guide is consistent with numpy.

@forfudan forfudan self-requested a review February 20, 2025 12:08
@forfudan forfudan added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 20, 2025
@forfudan
Copy link
Collaborator

De-indent the examples block according to the mojo style guide.

Otherwise, the hinter will render them in as one line.

Copy link
Collaborator

@forfudan forfudan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with some adjustment and reverts.

@forfudan forfudan merged commit c552c80 into Mojo-Numerics-and-Algorithms-group:pre-0.6 Feb 20, 2025
2 checks passed
forfudan added a commit that referenced this pull request Feb 26, 2025
@shivasankarka shivasankarka deleted the errors-and-docstrings branch March 10, 2025 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants