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

Audit & fix a-simple-calculation.md: #74

Merged
merged 4 commits into from
Nov 18, 2021

Conversation

minhhang107
Copy link
Contributor

Fixes #38

  • added alt tag, backticks
  • used admonitions
  • fixed markdown syntax
  • fixed typo
  • updated Frontmatter
  • removed unnecessary

* added alt tag, backticks
* used admonitions
* fixed markdown syntax
* fixed typo
* updated Frontmatter
* removed unnecessary <b>
```

_**destination**_ is a placeholder for the destination variable. _**expression**_ refers to the value to be assigned to the destination variable. = denotes the 'is assigned from' operation. We call **`=`** the assignment operator.
_**destination**_ is a placeholder for the destination variable. _**expression**_ refers to the value to be assigned to the destination variable. = denotes the 'is assigned from' operation. We call `=` the assignment operator.
Copy link
Contributor

Choose a reason for hiding this comment

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

= should be surrounded by backticks.

image

}
```

The **`const`** keyword qualifies the value stored in in the 'variable' pi as unmodifiable.
The `const` keyword qualifies the value stored in in the 'variable' `pi` as unmodifiable.
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a spare in word in this sentence.

* the digit or letter enclosed in single quotes - for example 'A'
* the decimal value from the collating sequence - for example 65 for 'A' \(ASCII\)
* the hexadecimal value from the collating sequence - for example 0x41 for 'A' \(ASCII\)
* the digit or letter enclosed in single quotes - for example `'A'`
Copy link
Contributor

Choose a reason for hiding this comment

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

Since you already wrapped the first 'A' in backticks, I suggest doing the same for the other 2 to keep it consistent.


_**address**_ contains the address of the destination variable. We use the prefix & to refer to the 'address of' of a variable.
_**address**_ contains the address of the destination variable. We use the prefix `&` to refer to the 'address of' of a variable.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this is intentional or not, but there is also a spare of here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess this one is intentional

```

_**destination**_ is a placeholder for the destination variable. _**expression**_ refers to the value to be assigned to the destination variable. = denotes the 'is assigned from' operation. We call **`=`** the assignment operator.
_**destination**_ is a placeholder for the destination variable. _**expression**_ refers to the value to be assigned to the destination variable. = denotes the 'is assigned from' operation. We call `=` the assignment operator.
Copy link
Contributor

Choose a reason for hiding this comment

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

You can also wrap backticks for the = here.


### Format

_**format**_ is a string literal describing how to convert data stored in memory into text readable by the user. _**format**_ contains the conversion specifier and any characters to be output directly. The conversion specifier begins with a % symbol and identifies the type of the source variable. The most common specifiers are listed below.
_**format**_ is a string literal describing how to convert data stored in memory into text readable by the user. _**format**_ contains the conversion specifier and any characters to be output directly. The conversion specifier begins with a **`%`** symbol and identifies the type of the source variable. The most common specifiers are listed below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Since you already wrapped the % in backticks, I think there is no need to add emphasis with **

@@ -26,7 +30,7 @@ Constant values in a program can be numbers, characters, or string literals. Ea

We specify the type of a numeric constants by a suffix, if any, on the value itself and possibly a decimal point.

![](/img/image22.png)
![numeric-constants](/img/image22.png)

To define a numeric constant in hexadecimal representation, we prefix the value with 0x.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think 0x should be wrapped in backticks since it represents a hex code?

sidebar_position: 2
slug: /B-Computations/a-simple-calculation
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @minhhang107 , Nice work on this page!
Something that I noticed was:

Slug should be standardized in small caps and without the "B-"
Check #64 for more details.

Thank you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, I have updated the slug

@CameronGray1210 CameronGray1210 merged commit c2469c5 into Seneca-ICTOER:main Nov 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Audit and fix a-simple-calculation.md page
7 participants