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.

Sign up for GitHub

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

Jump to bottom

adding explanation to 'example.aliases.sh' #499

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

adding explanation to 'example.aliases.sh' #499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions custom/aliases/example.aliases.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
# will override ones with the same name in the main alias directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line doesn't fit in 79 characters. Column 80 is reserved for the line continuation mark (such as \) in typical text editors.

#
# please note that you have to:
#
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

# 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)
# 2. add the leading part of that filename ('my_aliases' in this example) to
Comment on lines +6 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

# the 'aliases' array in your ~/.bashrc
Loading