From 0e1b273a2598e4e05fc24e244022e0d127ec8287 Mon Sep 17 00:00:00 2001 From: John Barrett <40014477+274188A@users.noreply.github.com> Date: Fri, 28 Sep 2018 10:01:17 +0800 Subject: [PATCH] small grammar changes --- docs/Module-Development-Basics.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/Module-Development-Basics.md b/docs/Module-Development-Basics.md index 43435ef080..c2b106ed42 100644 --- a/docs/Module-Development-Basics.md +++ b/docs/Module-Development-Basics.md @@ -2,11 +2,11 @@ ### Introduction -ABP itself is a modular framework. It also provides infrastructure and architectural model to develop your own modules. +ABP is itself a modular framework. It also provides an infrastructure and architectural model to develop your own modules. ### Module Class -Every module should define a module class. Most simple way of defining a module class is to create a class derived from ``AbpModule`` as like below: +Every module should define a module class. The simplest way of defining a module class is to create a class derived from ``AbpModule`` as shown below: ````C# public class BlogModule : AbpModule @@ -20,7 +20,7 @@ public class BlogModule : AbpModule ##### ConfigureServices Method -``ConfigureServices`` is the main method to add your services to dependency injection system and configure other modules. Example: +``ConfigureServices`` is the main method to add your services to the dependency injection system and configure other modules. Example: ````C# public class BlogModule : AbpModule @@ -32,9 +32,9 @@ public class BlogModule : AbpModule } ```` -You can register dependencies one by one as stated in Microsoft's documentation. Bu ABP has a **conventional dependency registration system** which automatically register all services in your assembly. See the [dependency Injection](Dependency-Injection.md) documentation for more about the dependency injection system. +You can register dependencies one by one as stated in Microsoft's documentation. But ABP has a **conventional dependency registration system** which automatically register all services in your assembly. See the [dependency Injection](Dependency-Injection.md) documentation for more about the dependency injection system. -You can also configure other services and modules in this method. Example: +You can also configure other services and modules in this way. Example: ````C# public class BlogModule : AbpModule @@ -54,11 +54,11 @@ See Configuration (TODO: link) document for more about the configuration system. ##### Pre & Post Configure Services -``AbpModule`` class also defines ``PreConfigureServices`` and ``PostConfigureServices`` methods to override and write your code just before and just after ``ConfigureServices``. Notice that the code you have written into these methods will be executed before/after ``ConfigureServices`` methods of all other modules. +``AbpModule`` class also defines ``PreConfigureServices`` and ``PostConfigureServices`` methods to override and write your code just before and just after ``ConfigureServices``. Notice that the code you have written into these methods will be executed before/after the ``ConfigureServices`` methods of all other modules. #### Application Initialization -Once all services of all modules are configured, application starts by initializing all modules. In this phase, you can resolve services from ``IServiceProvider`` since it's ready and available. +Once all the services of all modules are configured, the application starts by initializing all modules. In this phase, you can resolve services from ``IServiceProvider`` since it's ready and available. ##### OnApplicationInitialization Method @@ -77,7 +77,7 @@ public class BlogModule : AbpModule } ```` -``OnApplicationInitialization`` is generally used by the startup module to construct middleware pipeline for ASP.NET Core applications. Example: +``OnApplicationInitialization`` is generally used by the startup module to construct the middleware pipeline for ASP.NET Core applications. Example: ````C# [DependsOn(typeof(AbpAspNetCoreMvcModule))] @@ -100,19 +100,19 @@ public class AppModule : AbpModule } ```` -You can also perform startup logic if your module requires +You can also perform startup logic if your module requires it ##### Pre & Post Application Initialization -``AbpModule`` class also defines ``OnPreApplicationInitialization`` and ``OnPostApplicationInitialization`` methods to override and write your code just before and just after ``OnApplicationInitialization``. Notice that the code you have written into these methods will be executed before/after ``OnApplicationInitialization`` methods of all other modules. +``AbpModule`` class also defines ``OnPreApplicationInitialization`` and ``OnPostApplicationInitialization`` methods to override and write your code just before and just after ``OnApplicationInitialization``. Notice that the code you have written into these methods will be executed before/after the ``OnApplicationInitialization`` methods of all other modules. #### Application Shutdown -Lastly, you can override ``OnApplicationShutdown`` method if you want to execute a code while application is beign shutdown. +Lastly, you can override ``OnApplicationShutdown`` method if you want to execute some code while application is beign shutdown. ### Module Dependencies -In a modular application, it's typical a module depends on other modules. An Abp module must declare ``[DependsOn]`` attribute if it depends on another module, as shown below: +In a modular application, it's not unusual for one module to depend upon another module(s). An Abp module must declare ``[DependsOn]`` attribute if it does have a dependcy upon another module, as shown below: ````C# [DependsOn(typeof(AbpAspNetCoreMvcModule))] @@ -125,4 +125,4 @@ public class BlogModule You can use multiple ``DependsOn`` attribute or pass multiple module types to a single ``DependsOn`` attribute depending on your preference. -A depended module may depend on another module, but you only need to define your direct dependencies. ABP investigates dependency graph on application startup and initializes/shutdowns modules in the correct order. \ No newline at end of file +A depended module may depend on another module, but you only need to define your direct dependencies. ABP investigates the dependency graph for the application at startup and initializes/shutdowns modules in the correct order.