From 7c86f45b48ba38ea7b10beda0c4738ec721ba94a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=A8=E6=B6=9B?= Date: Thu, 16 May 2019 11:59:48 +0800 Subject: [PATCH] Fix typos and links in the documentation --- docs/en/AspNetCore/Auto-API-Controllers.md | 4 ++-- docs/en/Best-Practices/Entities.md | 2 +- docs/en/Module-Development-Basics.md | 2 +- docs/en/Modules/Index.md | 2 +- docs/en/Multi-Tenancy.md | 2 +- docs/en/Repositories.md | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/AspNetCore/Auto-API-Controllers.md b/docs/en/AspNetCore/Auto-API-Controllers.md index db7fb63642..b81afbcac4 100644 --- a/docs/en/AspNetCore/Auto-API-Controllers.md +++ b/docs/en/AspNetCore/Auto-API-Controllers.md @@ -1,6 +1,6 @@ # Auto API Controllers -Once you create an [application service](Application-Services.md), you generally want to create an API controller to expose this service as an HTTP (REST) API endpoint. A typical API controller does nothing but redirects method calls to the application service and configures the REST API using attributes like [HttpGet], [HttpPost], [Route]... etc. +Once you create an [application service](../Application-Services.md), you generally want to create an API controller to expose this service as an HTTP (REST) API endpoint. A typical API controller does nothing but redirects method calls to the application service and configures the REST API using attributes like [HttpGet], [HttpPost], [Route]... etc. ABP can **automagically** configures your application services as MVC API Controllers by convention. Most of time you don't care about its detailed configuration, but it's possible fully customize it. @@ -106,7 +106,7 @@ public class PersonAppService : ApplicationService ### TypePredicate Option -You can further filter classes to become an API controller by providing the `TypePedicate` option: +You can further filter classes to become an API controller by providing the `TypePredicate` option: ````csharp services.Configure(options => diff --git a/docs/en/Best-Practices/Entities.md b/docs/en/Best-Practices/Entities.md index 03843c5278..1c76469cb7 100644 --- a/docs/en/Best-Practices/Entities.md +++ b/docs/en/Best-Practices/Entities.md @@ -63,7 +63,7 @@ public class Issue : FullAuditedAggregateRoot //Using Guid as the key/iden protected Issue() { - /* This conctructor is for ORMs to be used while getting the entity from database. + /* This constructor is for ORMs to be used while getting the entity from database. * - No need to initialize the Labels collection since it will be overrided from the database. - It's protected since proxying and deserialization tools diff --git a/docs/en/Module-Development-Basics.md b/docs/en/Module-Development-Basics.md index 6a0561a0c5..8149ec2cb1 100644 --- a/docs/en/Module-Development-Basics.md +++ b/docs/en/Module-Development-Basics.md @@ -112,7 +112,7 @@ Lastly, you can override ``OnApplicationShutdown`` method if you want to execute ## Module Dependencies -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: +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 dependency upon another module, as shown below: ````C# [DependsOn(typeof(AbpAspNetCoreMvcModule))] diff --git a/docs/en/Modules/Index.md b/docs/en/Modules/Index.md index 9dc5da7a99..2771c9a8a9 100644 --- a/docs/en/Modules/Index.md +++ b/docs/en/Modules/Index.md @@ -21,6 +21,6 @@ There are some **free and open source** application modules developed and mainta * **Permission Management**: Used to persist permissions. * **Setting Management**: Used to persist settings. * **Tenant Management**: Used to manage tenants for a [multi-tenant](../Multi-Tenancy.md) application. -* **Users**: Used the abstract users, so other modules can depend on this instead of the Identity module. +* **Users**: Used to abstract users, so other modules can depend on this instead of the Identity module. Documenting the modules is in the progress. See [this repository](https://github.com/abpframework/abp/tree/master/modules) for source code of all modules. \ No newline at end of file diff --git a/docs/en/Multi-Tenancy.md b/docs/en/Multi-Tenancy.md index ee0648f483..f5510a82db 100644 --- a/docs/en/Multi-Tenancy.md +++ b/docs/en/Multi-Tenancy.md @@ -56,7 +56,7 @@ namespace MyCompany.MyProject } ```` -IMultiTenant requires to define a **TenantId** property in the implementing entity (See entity documentation (TODO: link) for more about entities). +IMultiTenant requires to define a **TenantId** property in the implementing entity (See [entity documentation](Entities.md) for more about entities). #### Obtain Current Tenant's Id diff --git a/docs/en/Repositories.md b/docs/en/Repositories.md index 3e4a46a4f5..e6b55cb3de 100644 --- a/docs/en/Repositories.md +++ b/docs/en/Repositories.md @@ -48,8 +48,8 @@ In this example; Generic Repositories provides some standard CRUD features out of the box: -* Providers `Insert` method to save a new entity. -* Providers `Update` and `Delete` methods to update or delete an entity by entity object or it's id. +* Provides `Insert` method to save a new entity. +* Provides `Update` and `Delete` methods to update or delete an entity by entity object or it's id. * Provides `Delete` method to delete multiple entities by a filter. * Implements `IQueryable`, so you can use LINQ and extension methods like `FirstOrDefault`, `Where`, `OrderBy`, `ToList` and so on... * Have **sync** and **async** versions for all methods.