Update docs to better distinguish among getCurrentDir, getProjectPath and currentSourcePath

[kaushalmodi]

Summary

Update docs so that the different "current path" procs are not confused among each other.

Description

I'll send a PR to attempt the fix the docs for those 3 procs/templates and also point the user to the other 2 procs from each proc doc-string.

.. and with examples.

Additional Information

• https://irclogs.nim-lang.org/28-01-2019.html#04:19:09

[timotheecour]

I'll send a PR to attempt the fix the docs for those 3 procs/templates

just make sure its DRY (ie please don't copy paste that description in all 3 places); hopefully that was your intention indeed; wasn't sure;

i don't like when docs do that, it immediately triggers the search for whether there's a subtle difference in the 2 descriptions, eg:
this snippet which is repeated twice:
https://nim-lang.github.io/Nim/system.html#int-max_1

Note that the sequence will be filled with zeroed entries, which can be a problem for sequences containing strings since their value will be nil. After the creation of the sequence you should assign entries to the sequence instead of adding them. Example:

(i don't know whether it's good to remind also in that description that paths (eg import "."/foo/bar) are relative to the file doing the import)

(ditto with the subtle gorgeEx that sets workingDir to file where gorgeEx is called, although that should probably left out of your description)

[narimiran]

I'll send a PR to attempt the fix the docs for those 3 procs/templates and also point the user to the other 2 procs from each proc doc-string.

@kaushalmodi any news on this? Did you send a PR but didn't reference this issue?

[kaushalmodi]

@narimiran No, this fell down the sideways.. I'll find some time this week to submit that PR and close this issue. Thanks for the reminder.

I'll be porting stuff from https://scripter.co/notes/nim/#fetching-various-paths in some manual-friendly way.