doc/tut1: new section on functions and methods

[ZoomRmc]

This PR adds a new section on functions and methods to the first part of the tutorial.

The added text clarifies the differences between the three and provides some benefits of using funcs which explains their existence in the language.

This PR aims to answer a repeating question of "which of the three should I use?" coming from new language users, which was observed on multiple occasions by the @PMunch and others.

Most of the work is by @PMunch, part about functions coauthored by me in a declined edit of the merged PR (nim-lang/Nim#19207)

[saem]

Change all references to nimskull

[alaviss]

You should change the commit author to PMunch <[email protected]>, then add the following Co-authored-by as evident by upstream commit:

Co-authored-by: Danil Yarantsev <[email protected]>
Co-authored-by: konsumlamm <[email protected]>
Co-authored-by: Zoom <[email protected]>

When backporting I'd prefer that we keep as much authoring metadata as possible.

[saem]

This is a good idea, in starting to review further.

We have pr guidelines so could you start sprucing up the description accordingly for others? I don't want to have strong references into Nim as we do things differently and I don't want to give people the wrong omissions as they try and soft through what does and doesn't make sense.

[ZoomRmc]

Change all references to nimskull

Wait, do you mean the whole doc? Changing only in the edited section doesn't make a lot of sense.

could you start sprucing up the description accordingly for others

Not sure I'm following. Sprucing up what description accordingly to what?

[saem]

Change all references to nimskull

Wait, do you mean the whole doc? Changing only in the edited section doesn't make a lot of sense.

Let me clarify, I recently added |NimSkull| and |Nim| (not preferred) to rstcommon.rst, you can check them out here. Please use those at least for the parts you edited -- broader change can be separate, but I'd prefer that first to be honest.

could you start sprucing up the description accordingly for others

Not sure I'm following. Sprucing up what description accordingly to what?

We have a PR template, that should have popped up, please see the contents here, thanks.

Specifically, here are some good starting points:

• shortening the title, no reference to upstream -- they are not
• doc/tutorial: is likely a reasonable prefix
• the PR template tips around current state and why these are good changes

Hope those clarify things, keep the questions coming we'll help ya along!

[saem]

Sneaky ones

[saem]

Bors r+

[saem]

Thanks, @ZoomRmc!

Happy early first commit into nimskull. 🎉 👍🏽 😄

[bors]

Build succeeded:

• All check passed
• Reproducibility tests