Humble sumission for function help
neztach opened this issue · comments
I took curser.sh and leveraged it to add function help for O365Essentials in hopes that it may be of some use to you for documentation.
Please have a look and I sincerely hope it helps you and this project.
https://github.com/neztach/PS-Public/blob/master/evotec-O365Essentials.ps1
Hi,
I have no use for it if its not provided as PR and added directly to sources. Using my main psm1 and modifying it would mean i need to reapply whatever you created and spend lots of time on applying it to sources.
If you can learn PR on github I'm sure more docs would help.
I created a fork, and put my edits there. Will that work?
Yes, you then create PR from it:
However 2 things I would like to ask:
- Each file you remove and add last lines? Not sure if necessary?
- I believe the formatting looks better in this way? So basically one line white space and without additional tab would be better
submitted. I could go back and add the spacing if need be to the help as you indicated. I'm just trying to help out since I sincerely love the content you've released and I've learned SO much from you. I wanted to try to contribute and give back if possible.
Please let me know if this is a valuable contribution, and what alterations you'd like me to make other than writing help for the Functions I didn't already.
It is valuable contribution and you shouldn't even need to ask. I love when people help with my projects, even if it's basic things. I've loads of modules that lack help, I have loads of modules that require tests, I've loads of modules that requires fixes and improvements so if people want to help - that's great. I don't have time to do a lot of things, and sometimes I do just enough for things to work. I have plenty of modules that I've not even blogged about to spread the word that they exists. I started also adding readme , showing more usage scenarios and all the details - so if you want you can help with that as well.
Generally I'll take any help I can get with anything :)
I saw your latest commit and I believe you also need to fix this:
So basically remove the blue part. I'm sure it's valid comment but my modules usually use no space/tabs
I know it's a bit pain and not really important, as Get-Help will work either way, but it's just synthetic sugar for me :)
gotcha! OK I'll go through and remedy those, and then I guess submit another pull request?
no, when you commit changes they update the PR directly.
When you do a fork, and you have single branch, and you change something in it, and then do PR, as long as you stay within same branch
You will keep on adding files to this same branch, which will continue updating the PR. You can also mark the PR as draft until you're happy with results.
ok help updated as requested. Please let me know what else I can help with.
What about:
It seems to be in every file? Btw you don't need to commit per file, you can bundle it up under one commit ;)
I honestly have no idea. After I forked your repo, I went through the regular Github web interface and edited each file only to add the help, then saved. I didn't mess with any other parts of the code.
You should try VSCode - doing it via GitHub Web is painful. I'll take a look how to fix it.
pulled my fork into curser with git, finished adding help to functions I previously missed. Still don't see the double close curly brace. But you were right of course, single pull - make all changes - stange with comment - single push - easy.
At least I got through my previously missed function help.