Skip to content

Commit d28031a

Browse files
authored
Fixing typos and grammatical errors and rewriting a few sentences. (#7)
Fixes to the grammar and understanding of use integrated checker but does not edit the final paragraph fixing code style violations.
1 parent 5b7882b commit d28031a

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

docs/get-started/codestyle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ sidebar_position: 5
44
Coding Style Guide
55
=======================
66

7-
Since Joomla version 4.2 Joomla is using the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standard. You can enable the coding standard in your IDE to get hints when you're violating the rules or can use an auto fix, too.
8-
We recommend that you follow this standard also when developing your own extensions to stay compatible always with core and that you don't have to switch when working with core.
7+
Since Joomla version 4.2, Joomla uses the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standard. You can enable this coding standard in your IDE and get hints if you're not following the coding standard or use an auto fix, too.
8+
We recommend that you follow this standard when developing your own extensions to stay compatible with core and to ensure your code will hopefully work with future versions.
99

1010
## Install code style checker
1111
:::caution TODO
1212
Copy from https://docs.joomla.org/Joomla_CodeSniffer and update to the new version
1313
:::
1414

1515
## Use integrated checker
16-
The Joomla core system is shipping a so called "code sniffer" and a "code fixer" to check for code standard violations and to fix most (but sometimes not all) of them. This only works if you're using the full developer version from GitHub, not when you're working with a installation zip package.
16+
If you download the full developer version from GitHub of Joomla (not the downloadable installation zip package), you will find a so called "code sniffer", to check for coding standard violations, and a "code fixer" to fix most (but, sometimes, not all) of them.
1717

1818
To run the code sniffer/fixer you need to start a terminal, navigate to your Joomla root folder (the folder where your Joomla is installed) and run one of the following commands (don't forget the "."):
1919

docs/get-started/ide/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ sidebar_position: 1
33
---
44
IDE
55
===
6-
To develop a Joomla extension we recommend to use an Integrate Development Environment (IDE). An IDE has many benefits:
6+
To develop a Joomla extension we recommend that you use an Integrated Development Environment (IDE). An IDE has many benefits:
77
- Code completion
8-
- Getting suggestions for code to save reseaching code and avoid errors
9-
- Auto-implement namespace usage
8+
- Getting suggestions for code completion which saves researching existing code and helps avoid errors
9+
- Auto-implementing namespace usage
1010
- Type hinting when using well documented classes, methods and functions
11-
- Auto comments for classes/methods/functions
11+
- Building auto comments for classes/methods/functions
1212
- Code analyser
1313
- Automate code style feedback
1414
- Hints for "smelling code" to improve the code quality
1515
- Project/Folder management for extension projects
16-
- many addons/support for daily coding
16+
- Many addons/support for daily coding
1717

1818
The two current leading IDEs are [Visual Studio Code](get-started/ide/visual-studio-code.md) and [phpStorm](get-started/ide/phpstorm.md)
1919

docs/get-started/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 1
55
Get Started
66
===============
77
## Welcome to the Joomla Developers Manual
8-
The purpose of this guide is to give developers an upto date guide showing best practice in
8+
The purpose of this guide is to give developers an up to date guide showing best practice in
99
writing and maintaining Joomla extensions.
1010
It also offers a migration path for extensions from older Joomla! versions to the latest standard.
1111
We will run through the tools and process required to set up a local development environment with
@@ -15,7 +15,7 @@ the ability to get the most out of the guide as a developer.
1515
- @TODO
1616

1717
## Community
18-
- Check the latest state od the Joomla CMS code at [GitHub](https://github.com/joomla/joomla-cms)
18+
- Check the latest state of the Joomla CMS code at [GitHub](https://github.com/joomla/joomla-cms)
1919
- Find the latest version at [Joomla.org](https://joomla.org)
2020
- Join our [Mattermost-Community](https://joomlacommunity.cloud.mattermost.com/)
2121
- Read the [End-User documentation](https://docs.joomla.org)
@@ -26,14 +26,13 @@ the ability to get the most out of the guide as a developer.
2626
The Joomla Developers Manual is written using Docusaurus, a system that can allow all users of Joomla to
2727
contribute to the documentation using Markdown language.
2828

29-
A good place to start if new to Markdown is the Markdown Guide
29+
A good place to start, if new to Markdown, is the Markdown Guide
3030
https://www.markdownguide.org/
3131

32-
The documentation is maintained via GitHub where you can anytime create/edit/delete content to improve the content
33-
of the documentation. Click the **Edit this Page** link at the bottom of this page to contribute via a Pull Request.
32+
The documentation is maintained via GitHub where you can at anytime create/edit/delete content to improve the documentation. Click the **Edit this Page** link at the bottom of this page to contribute via a Pull Request.
3433

3534
:::caution TODO
3635

3736
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
3837

39-
:::
38+
:::

0 commit comments

Comments
 (0)