Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comments with reference links to scripts #82

Open
mkasberg opened this issue Oct 5, 2022 · 1 comment
Open

Add comments with reference links to scripts #82

mkasberg opened this issue Oct 5, 2022 · 1 comment
Labels
good first issue Good for newcomers Hacktoberfest Good issue for Hacktoberfest

Comments

@mkasberg
Copy link
Owner

mkasberg commented Oct 5, 2022

When we use an argument parsing utility in our sample scripts (like getopts in bash), it would be good to link to the documentation of that library/method so someone who wants to modify the sample script can easily find a reference to read about how the method works and what it's capabilities are. Where possible, this should be a link to official documentation (instead of StackOverflow or a blog).

Example for bash: #81

@mkasberg mkasberg added good first issue Good for newcomers Hacktoberfest Good issue for Hacktoberfest labels Oct 5, 2022
@mkasberg
Copy link
Owner Author

mkasberg commented Oct 7, 2022

Made progress in #84 and #87. Only language that could still use a link to the docs is perl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers Hacktoberfest Good issue for Hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant