adding explanation to 'example.aliases.sh' #499
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adding explanation on how to use to './custom/aliases/example.aliases.sh'
akinomyoga
requested changes
Nov 26, 2023
There was a problem hiding this comment.
Could you also update the description in README?
For consistency, you also need similar changes to the other types of custom modules.
| @@ -1,2 +1,9 @@ | |||
| # Add your own custom alias in the custom/aliases directory. Aliases placed | |||
| # here will override ones with the same name in the main alias directory. | |||
| # Add your own custom alias in the custom/aliases directory. Aliases placed here | |||
There was a problem hiding this comment.
This line doesn't fit in 79 characters. Column 80 is reserved for the line continuation mark (such as \) in typical text editors.
Comment on lines
+6
to
+7
| # 1. use the exact naming schema like '<my_aliases>.aliases.sh' where the | ||
| # filename ending ~.aliases.sh is obligatory (just <my_aliases>.sh won't do) |
There was a problem hiding this comment.
Suggested change
| # 1. use the exact naming schema like '<my_aliases>.aliases.sh' where the | |
| # filename ending ~.aliases.sh is obligatory (just <my_aliases>.sh won't do) | |
| # 1. use the exact naming schema like '<my_aliases>.aliases.sh' where the | |
| # filename needs to end with .aliases.sh (just <my_aliases>.sh does not work) |
RobLoach
reviewed
Sep 1, 2024
| # Add your own custom alias in the custom/aliases directory. Aliases placed here | ||
| # will override ones with the same name in the main alias directory. | ||
| # | ||
| # please note that you have to: |
There was a problem hiding this comment.
In general, technical documentation tends to avoid using terms like "please" because when does one know when or not to use them?
I'd recommend having this be a title...
Suggested change
| # please note that you have to: | |
| # Usage |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adding explanation on how to practically use './custom/aliases/example.aliases.sh'