Skip to content

Commit 94db909

Browse files
committed
Fix spelling in Api docs doc page
1 parent e792e97 commit 94db909

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/Contributing/Updating-the-API-documentation.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,71 +4,71 @@
44

55
The [BHoM API](https://bhom.xyz/api/oM/) documentation is built using mkdocs, which is the same documentation library that is used to generate the general documentation. For more information about this, please see [Editing the documentation](../Editing-the-documentation).
66

7-
The [BHoM API](https://bhom.xyz/api/oM/) built up automatically [generated markdown pages](#api-generation), one per class. The md files are stored in the [api repo](https://github.com/BHoM/api) under the [docs/oM](https://github.com/BHoM/api/tree/main/docs/oM) folder. The api website is automatically being updated via github actions as soon as any changes to the files is pushed to the main branch on the repository.
7+
The [BHoM API](https://bhom.xyz/api/oM/) is built up automatically [generated markdown pages](#api-generation), one per class. The md files are stored in the [api repo](https://github.com/BHoM/api) under the [docs/oM](https://github.com/BHoM/api/tree/main/docs/oM) folder. The api website is automatically updated via github actions as soon as any changes to the files are pushed to the main branch on the repository.
88

99
### Including a repository to be documented
1010

11-
The repositories and projects to be documented is controlled via the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) csv file as well as the [Repos](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/Repos.txt).
11+
The repositories and projects to be documented are controlled via the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) csv file as well as the [Repos](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/Repos.txt).
1212

1313
To get a project included:
1414
- Ensure the repo it belongs to is in the [Repos](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/Repos.txt). If not, add it, and make sure to put it after all repos it depends on for building
15-
- Add it to the list of projects in the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) file. Make sure you use one of the pre-exiting categorisations, and make sure that the last field is set to true. If you repo contains more than one oM and you just want one of them to be documented, then please add it to the list and set the "To be documented" flag to false.
15+
- Add it to the list of projects in the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) file. Make sure you use one of the pre-existing categorisations, and make sure that the last field is set to true. If your repo contains more than one oM and you just want one of them to be documented, then please add it to the list and set the "To be documented" flag to false.
1616

1717
### Including example JSON
1818

1919
For some classes, in particular for classes that are to be shared, it can be useful to show an example of how a BHoM JSON looks. To enable this for a particular class, please do the following:
2020

2121
- Generate a JSON file with a single object for the type you want to display, and name the file with the name of the type. Should generally be an as simple example as possible, that still highlights the potential complexity of the type.
2222
- Add the file to the [Json examples](https://github.com/BHoM/api/tree/main/APIGenerator/APIGenerator/JsonExamples) page, under the folder corresponding to the name of the dll hosting the type.
23-
- Raise a pullrequest to min with the changes.
23+
- Raise a pull request to main with the changes.
2424

2525
## API generation
2626

27-
The api docs will be automatically be updated by [github actions](https://github.com/BHoM/api/actions/workflows/generation.yml) using the [APIGenerator](#apigenerator) project described in more detail below.
27+
The api docs will be automatically updated by [github actions](https://github.com/BHoM/api/actions/workflows/generation.yml) using the [APIGenerator](#apigenerator) project described in more detail below.
2828

29-
The github action triggers every week on the night between saturday and sunday UTC, and creates a pull request if any changes are detected. For the changes to affect the live website, this PR needs to be merged. To view open PRs please see [Pull Requests](https://github.com/BHoM/api/pulls). Once the PR is merged, the website will be [automatically updated](#general).
29+
The github action triggers every week on the night between Saturday and Sunday UTC, and creates a pull request if any changes are detected. For the changes to affect the live website, this PR needs to be merged. To view open PRs please see [Pull Requests](https://github.com/BHoM/api/pulls). Once the PR is merged, the website will be [automatically updated](#general).
3030

3131
### Steps to update the docs manually
3232

3333
If you want to update the api docs manually, please follow the steps below
3434

3535
1. Clone the [api](https://github.com/BHoM/api) repo
3636
1. Ensure you have all code built and up to date in your BHoM assemblies folder.
37-
- This could either be done by runnign an up to date installer or cloning and building all the code from source
37+
- This could either be done by running an up to date installer or cloning and building all the code from source
3838
- If this is done via the means of an installer, make sure any repos listed in the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) file is cloned and built manually
3939
1. Clone all listed repos in the [categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) file into the 'Repositories' folder in the root folder of the api solution.
4040
- If the folder does not exist, create it
41-
- Reason the repos need to be cloned into the repository if for the github actions to function as it requires everything to be contain in the currently running repository
41+
- The reason the repos need to be cloned into the repository is for the github actions to function as it requires everything to be contained in the currently running repository
4242
1. Remove all subfolders in the 'docs/oM' folders, as well as their content. Be sure to _not_ delete index.md file.
43-
- Reason for removing all files is to make sure that and class no lonbger present is also removed from the docs. This includes renaming a class or its namespace, as that technically will mean a new file added and the old one hence needs to be removed.
43+
- The reason for removing all files is to make sure that any class no longer present is also removed from the docs. This includes renaming a class or its namespace, as that technically will mean a new file is added and the old one hence needs to be removed.
4444
1. Open and build the [APIGenerator solution](https://github.com/BHoM/api/tree/main/APIGenerator)
4545
1. Run the resulting exe
4646
- Could be run by just hitting f5 in the solution in visual studio
4747
- Inspect any messaging display for any issues
48-
1. Inspect the changes to the files locally, recomended to inspect in github desktop
49-
1. Raise a pullrequest to main with the changes
48+
1. Inspect the changes to the files locally, recommended to inspect in github desktop
49+
1. Raise a pull request to main with the changes
5050

5151

5252
### APIGenerator
5353

54-
The for the app to function, it should be run ina subfolder of the solution file. If you simply build it and run and run it from the build location, or just hit f5 from the solution this will be the case. The reason this is required is due to the fact that the app requires access to settings files as well as the example jsons, which are linked through via finding the repo root folder, and then accessed via those paths.
54+
For the app to function, it should be run in a subfolder of the solution file. If you simply build it and run it from the build location, or just hit f5 from the solution this will be the case. The reason this is required is due to the fact that the app requires access to settings files as well as the example jsons, which are linked through via finding the repo root folder, and then accessed via those paths.
5555

5656
#### Overview
57-
The APIGenerator solution is a single projectconsole app, generating a .exe app that when run generates all the markdown files. Given the prerequisite [steps](#steps-to-update-the-docs-manually) has been set up, it willgenerate a .md file per .cs file in the oMs. To do this, it makes use of data from multiple sources:
57+
The APIGenerator solution is a single project console app, generating a .exe app that when run generates all the markdown files. Given the prerequisite [steps](#steps-to-update-the-docs-manually) have been set up, it will generate a .md file per .cs file in the oMs. To do this, it makes use of data from multiple sources:
5858
- Compiled oM dlls to extract:
5959
- Name and namespace of the type
6060
- Defining properties
61-
- Class and interface heirachy
61+
- Class and interface hierarchy
6262
- Compiled Engine dlls to extract:
6363
- Derived properties (extension methods)
6464
- [Categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) csv file to extract
65-
- Categoriesation of the oM into the main defined categories
65+
- Categorisation of the oM into the main defined categories
6666
- Cloned files to extract:
67-
- File heirachy to be matched for generated .md files
67+
- File hierarchy to be matched for generated .md files
6868
- [BHoM JSON Schema](https://github.com/BHoM/BHoM_JSONSchema) to extract:
69-
- JSON schema of the obejcts
69+
- JSON schema of the objects
7070
- Json examples
71-
- Only availible for types where it has been explicitly added. See [Including example JSON](#including-example-json)
71+
- Only available for types where it has been explicitly added. See [Including example JSON](#including-example-json)
7272

7373

7474
#### Program steps
@@ -80,10 +80,10 @@ Parses the oM_categorisation.csv file to check for oMs to be documented
8080
Loads up all Engine dlls from the programdata folder that are in the BHoM organisation. To check the organisation, it checks the AssemblyDescriptionAttribute for the link, and makes sure it links over to a github repository in the BHoM organisation. If your Engine methods does not show up in there, please ensure your project file has been [set up properly](/docs/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/Project-References-and-Build-Paths/#assembly-information).
8181

8282
##### Extract extention methods
83-
This step extracts all extention methods that could be seen as Derived properties. The methods captured by this step are methods that fullfill the following conditions:
83+
This step extracts all extension methods that could be seen as Derived properties. The methods captured by this step are methods that fulfill the following conditions:
8484

8585
1. Are Query methods
86-
1. fullfuls one of the following:
86+
1. fulfills one of the following:
8787
- Have a single input parameter
8888
- Have more than one input parameter, but all but the first have default values (optional).
8989

@@ -93,10 +93,10 @@ All methods that match this criteria will be added as derived properties to the
9393
Loads up all Engine dlls from the programdata folder that are in the BHoM organisation and also listed in the [Categorisation](https://github.com/BHoM/api/blob/main/APIGenerator/APIGenerator/oM_categorisation.csv) csv file. To check the organisation, it checks the AssemblyDescriptionAttribute for the link, and makes sure it links over to a github repository in the BHoM organisation. If your objects does not show up, please ensure it is listed in the csv file and please ensure your project file has been [set up properly](/docs/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/Project-References-and-Build-Paths/#assembly-information).
9494

9595
##### Map types:
96-
Maps the inheritance heirachy between the types. Stores information both about all base types (classes as well as interfaces) for the type, and also adds itself as a subtype to all of its base types.
96+
Maps the inheritance hierarchy between the types. Stores information both about all base types (classes as well as interfaces) for the type, and also adds itself as a subtype to all of its base types.
9797

9898
##### Generate markdown
99-
Loops through all files and generates a .md file per type in all the oM assemblies loaded in the [previous step](#load-om-assemblies), that fullfills the following conditions:
99+
Loops through all files and generates a .md file per type in all the oM assemblies loaded in the [previous step](#load-om-assemblies), that fulfills the following conditions:
100100
1. Is _not_ abstract AND sealed (filters out autogenerated types)
101101
1. Is assignable from IObject OR an enum
102102

0 commit comments

Comments
 (0)