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

docs: Edit spellling errors in Read.md files #8264 #8279

Merged
merged 4 commits into from
May 23, 2023

Conversation

oyenuga17
Copy link
Contributor

What

Corrected the spelling errors in
-How-to-learn-Perl.md
-explain-packaging-data.md
-explain-taxonomy-build-cache.md
-how-to-update-agribalyse-ecoscore.md

Related issue(s) and discussion

  • Fixes #[8264]

@oyenuga17 oyenuga17 requested a review from a team as a code owner April 1, 2023 21:17
@github-actions github-actions bot added the 📚 Documentation Documentation issues improve the project for everyone. label Apr 1, 2023
@oyenuga17
Copy link
Contributor Author

@alexgarel i made changes please review

@github-advanced-security
Copy link

You have successfully added a new SonarCloud configuration ``. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

@hangy hangy linked an issue Apr 1, 2023 that may be closed by this pull request
@@ -50,7 +50,7 @@ In 2020, we made this field a taxonomized field. As a result, we now store the l

#### Packaging information / recycling instructions text field (READ and WRITE)

In 2020, we also added a language specific field ("packaging_text_[language code]" e.g. "packaging_text_en" for English) to store free text data about the packaging. It can contain the text of the recycling instructions printed on the packaging (e.g. "bottle to recycle, cap to discard"), or can be filled in by users (e.g. "1 PET plastic bottle to recycle, 1 plastic cap").
In 2020, we also added a language specific field ("packaging*text*[language code]" e.g. "packaging_text_en" for English) to store free text data about the packaging. It can contain the text of the recycling instructions printed on the packaging (e.g. "bottle to recycle, cap to discard"), or can be filled in by users (e.g. "1 PET plastic bottle to recycle, 1 plastic cap").
Copy link
Contributor

Choose a reason for hiding this comment

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

The underscore are part of the name of the variable, they should not be replaced with *, otherwise it removes the underscore and makes some text italic:

image

Copy link
Contributor

@stephanegigandet stephanegigandet left a comment

Choose a reason for hiding this comment

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

Thank you for the corrections @oyenuga17 !

Could you put back the underscores that were replaced with * ? They are part of the variable names and should not be changed.

Thank you!

oyenuga17 and others added 2 commits April 3, 2023 10:35
revert vs-code underscore to asterisk formatting
Co-authored-by: Stéphane Gigandet <stephane@openfoodfacts.org>
@oyenuga17
Copy link
Contributor Author

@stephanegigandet please review

@sonarcloud
Copy link

sonarcloud bot commented Apr 3, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Contributor

@stephanegigandet stephanegigandet left a comment

Choose a reason for hiding this comment

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

Thank you @oyenuga17 !

@alexgarel alexgarel enabled auto-merge (squash) May 23, 2023 08:34
@sonarcloud
Copy link

sonarcloud bot commented May 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@alexgarel alexgarel merged commit 7953dbc into openfoodfacts:main May 23, 2023
@oyenuga17 oyenuga17 deleted the spelling-error branch May 23, 2023 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Documentation Documentation issues improve the project for everyone.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Edit spellling errors in Read.md files
3 participants