possee-org / genai-numpy

MIT License
4 stars 6 forks source link

Task: Polish up the examples for the `svdvals` function #49

Closed ogidig5 closed 3 months ago

ogidig5 commented 3 months ago

Description:

Last week, I created a branch on my GitHub to add examples to the svdvals function. After pushing the changes to my fork, I received some feedback to refine my examples. I have now implemented the suggested changes to my svdvals function example, removed the second example, and pushed the updated changes to my fork again. You can view the updates here: https://github.com/numpy/numpy/compare/main...ogidig5:numpy:add-svdvals-example

Here's what reflects when the docs build: Cleaned svdvals example

Acceptance Criteria:

bmwoodruff commented 3 months ago

George, I'm trying to guess what the mns and svns stand for, and it's not obvious at all. As a reader of the examples, I'm left trying to guess what that abbreviation stood for. Using matrix_non_square is much better. You did get rid of naming the output, then calling the output, which is an improvement.

bmwoodruff commented 3 months ago

Unfortunately, the code you have does not run. You have not called the function using appropriate syntax. This needs more work.