Skip to content

Conversation

@Buono-Marco
Copy link
Contributor

@Buono-Marco Buono-Marco commented Nov 11, 2022

Description

Added a new entry about the HTML element <s>

Type of Change

  • Adding a new entry

Checklist

  • All writings are my own.
  • My entry follows the Codecademy Docs style guide.
  • My changes generate no new warnings.
  • I have performed a self-review of my own writing and code.
  • I have checked my entry and corrected any misspellings.
  • I have made corresponding changes to the documentation if needed.
  • I have confirmed my changes are not being pushed from my forked main branch.
  • I have confirmed that I'm pushing from a new branch named after the changes I'm making.
  • Under "Development" on the right, I have linked any issues that are relevant to this PR (write "Closes # in the "Description" above).

@CLAassistant
Copy link

CLAassistant commented Nov 11, 2022

CLA assistant check
All committers have signed the CLA.

@SSwiniarski SSwiniarski linked an issue Nov 11, 2022 that may be closed by this pull request
3 tasks
@SSwiniarski SSwiniarski added html HTML entries new entry New entry or entries labels Nov 11, 2022
Copy link
Contributor

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@Buono-Marco, I did a first review and left a couple of comments.

- 'paths/front-end-engineer-career-path'
---

The **`<s>`** element is used to highlight no more pertinent, accurate, or wrong text. Browsers render it showing strikethrough text. Its behavior equals the <del> element but is semantically different. This last is usually used to show document changes.
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
The **`<s>`** element is used to highlight no more pertinent, accurate, or wrong text. Browsers render it showing strikethrough text. Its behavior equals the <del> element but is semantically different. This last is usually used to show document changes.
The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strikethrough text. Its behavior equals the <del> element but is semantically different, <del> is usually used to show document changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


```html
<s>
<!-- Text no more pertinent, accurate, or wrong to here -->
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
<!-- Text no more pertinent, accurate, or wrong to here -->
<!-- No longer pertinent, inaccurate, or wrong text 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.

Done

@SSwiniarski
Copy link
Contributor

@Buono-Marco, are you going to do another PR on the <del> tag?

@Buono-Marco
Copy link
Contributor Author

@Buono-Marco, are you going to do another PR on the <del> tag?

Yes

Copy link
Contributor

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@Buono-Marco Looks good for a second review.

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@Buono-Marco Finished with my review and left some comments/suggestions 😄


## Syntax

```html
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
```html
```pseudo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

</s>
```

The **`<s>`** element should only contain text content or other elements meant for text content.
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
The **`<s>`** element should only contain text content or other elements meant for text content.
The `<s>` element should only contain text content or other elements meant for text content.
> **Note:** The `<s>` element is semantically different from the `<del>` element because the former is just an edit while the latter conveys an actual update in a document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

- 'paths/front-end-engineer-career-path'
---

The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strikethrough text. Its behavior equals the <del> element but is semantically different, <del> is usually used to show document changes.
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
The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strikethrough text. Its behavior equals the <del> element but is semantically different, <del> is usually used to show document changes.
The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strike-through text.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@@ -0,0 +1,41 @@
---
Title: '<s>'
Description: 'Used to draw attention to one or more words, usually rendered in strikethrough text.'
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
Description: 'Used to draw attention to one or more words, usually rendered in strikethrough text.'
Description: 'Used to draw attention to one or more words, usually rendered in strike-through text.'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@Buono-Marco I had a few last comments/suggestions to offer. Could we also rename the image file to something like html-s-element-example.png and replace the old link on line # 47?

@@ -0,0 +1,47 @@
---
Title: '<s>'
Description: 'Used to draw attention to one or more words, usually rendered in strike-through text.'
Copy link
Contributor

@Dusch4593 Dusch4593 Nov 16, 2022

Choose a reason for hiding this comment

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

Suggested change
Description: 'Used to draw attention to one or more words, usually rendered in strike-through text.'
Description: 'Represents strike-through text that is no longer need, accurate, or correct.'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @Dusch4593,
is line 5 a refuse?

Copy link
Contributor

Choose a reason for hiding this comment

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

@Buono-Marco Yes! Sorry for that 😅

- 'paths/front-end-engineer-career-path'
---

The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strike-through text.
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
The **`<s>`** element is used to highlight no longer pertinent, inaccurate, or wrong text. Browsers render it showing strike-through text.
The **`<s>`** element represents strike-through text that is no longer needed, accurate, or correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


The rendered output would look like this:

![Rendered <s> tag example](https://raw.githubusercontent.com/Codecademy/docs/main/media/s-tag-example.png)
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
![Rendered <s> tag example](https://raw.githubusercontent.com/Codecademy/docs/main/media/s-tag-example.png)
![Rendered <s> element example](https://raw.githubusercontent.com/Codecademy/docs/main/media/s-tag-example.png)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


The `<s>` element should only contain text content or other elements meant for text content.

> **Note:** The `<s>` element is semantically different from the `<del>` element because the former is just an edit while the latter conveys an actual update in a document.
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
> **Note:** The `<s>` element is semantically different from the `<del>` element because the former is just an edit while the latter conveys an actual update in a document.
> **Note:** The `<s>` element is semantically different from the [`<del>`](https://www.codecademy.com/resources/docs/html/elements/del) element because the former is just an edit while the latter conveys an actual update in a document.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@Buono-Marco LGTM! 👍🏻

In 3c6893e, I made a small edit to the comment in the "Syntax" section.

@Dusch4593 Dusch4593 merged commit a9a761c into Codecademy:main Nov 17, 2022
@github-actions
Copy link

👋 @Buono-Marco
You have contributed to Codecademy Docs, and we would like to know more about you and your experience.
Please take a minute to fill out this four question survey to help us better understand Docs contributions and how we can improve the experience for you and our learners.
Thank you for your help!

@Dusch4593
Copy link
Contributor

Congrats and thank you so much for another solid contribution to Codecademy Docs, @Buono-Marco! 🎉 🥳 🎊

The entry should now be live: https://www.codecademy.com/resources/docs/html/elements/s

And hooray! It looks like your Codecademy profile is now visible ☺️
Screen Shot 2022-11-17 at 9 36 58 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Entry] HTML: <s> and <del> tags

5 participants