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

Add cosmetic changes #930

Merged
merged 1 commit into from
Nov 5, 2023
Merged

Add cosmetic changes #930

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
21 changes: 11 additions & 10 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Use Unix-style line endings.footnote:[*BSD/Solaris/Linux/macOS users are covered
====
If you're using Git you might want to add the following configuration setting to protect your project from Windows line endings creeping in:

[source,bash]
[source,shell]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For consistency. I know this is the valid source. https://docs.asciidoctor.org/asciidoc/latest/verbatim/source-highlighter/#shell-vs-console

Copy link
Member

Choose a reason for hiding this comment

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

What is worth noticing in the link:

[for console, ] the syntax highlighter will parse the prompt (e.g., $) at the start of each line, then handle the remaining text using the shell language

Should we use console here?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, console looks better here.

----
$ git config --global core.autocrlf true
----
Expand Down Expand Up @@ -328,7 +328,7 @@ foo&.bar
Avoid chaining of `&.`. Replace with `.` and an explicit check.
E.g. if users are guaranteed to have an address and addresses are guaranteed to have a zip code:

[source, ruby]
[source,ruby]
----
# bad
user&.address&.zip
Expand All @@ -338,7 +338,7 @@ user && user.address.zip
----

If such a change introduces excessive conditional logic, consider other approaches, such as delegation:
[source, ruby]
[source,ruby]
----
# bad
user && user.address && user.address.zip
Expand Down Expand Up @@ -3842,12 +3842,12 @@ This convention tends to reduce repetitive boilerplate in such classes.
[source,ruby]
----
class TestClass
# bad -- more work when class renamed/method moved
# bad - more work when class renamed/method moved
def self.call(param1, param2)
TestClass.new(param1).call(param2)
end

# bad -- more verbose than necessary
# bad - more verbose than necessary
def self.call(param1, param2)
self.new(param1).call(param2)
end
Expand Down Expand Up @@ -5505,9 +5505,10 @@ class Organization < ActiveRecord::Base
end

linux_organization = Organization.find(...)
# BAD - violates privacy

# bad - violates privacy
linux_organization.send(:reset_token)
# GOOD - should throw an exception
# good - should throw an exception
linux_organization.public_send(:reset_token)
----

Expand All @@ -5523,10 +5524,10 @@ u1 = UDPSocket.new
u1.bind('127.0.0.1', 4913)
u2 = UDPSocket.new
u2.connect('127.0.0.1', 4913)
# Won't send a message to the receiver obj.
# Instead it will send a message via UDP socket.

# bad - Won't send a message to the receiver object. Instead it will send a message via UDP socket.
u2.send :sleep, 0
# Will actually send a message to the receiver obj.
# good - Will actually send a message to the receiver object.
u2.__send__ ...
----

Expand Down