mojo icon indicating copy to clipboard operation
mojo copied to clipboard

[docs] Two helpful documentation additions

Open KarateCowboy opened this issue 9 months ago • 5 comments

Love what you folks are doing.

KarateCowboy avatar May 07 '24 02:05 KarateCowboy

@arthurevans New PR created, as directed.

KarateCowboy avatar May 07 '24 02:05 KarateCowboy

Thanks @KarateCowboy ! Everything seems good. The checks complain a bit about the title. We are usually adding [docs] or [stdlib] or [tools] at the start of the pull request title. Can you edit the PR title and change it to "[docs] Two helpful documentation additions" ? All the checks should be green afterwards :)

EDIT: I see that the notebook can't be displayed by github. Maybe there is an issue with the format. I'll look into it

gabrieldemarmiesse avatar May 07 '24 15:05 gabrieldemarmiesse

I updated the title. I used IntelliJ and a plugin to create the notebook. It's my first time making one so it may not be quite right. Let me know if you need any changes.

KarateCowboy avatar May 07 '24 16:05 KarateCowboy

Yeah, it's pretty weird. I would recommend that you modify this one: https://github.com/modularml/mojo/blob/nightly/docs/tools/debugging.ipynb instead of making a new notebook. It's less likely that you'll get into trouble

gabrieldemarmiesse avatar May 07 '24 17:05 gabrieldemarmiesse

✅🟣 This contribution has been merged 🟣✅

Your pull request has been merged to the internal upstream Mojo sources. It will be reflected here in the Mojo repository on the nightly branch during the next Mojo nightly release, typically within the next 24-48 hours.

We use Copybara to merge external contributions, click here to learn more.

modularbot avatar May 07 '24 18:05 modularbot