Merge pull request #152 from LucasNH/fix-typo-docs

Fixed a small typo in the Overview/Dataset section of the docs.

Author: calofonseca

assets/tables/citylearn_schema_definition.csv

@@ -12,15 +12,15 @@ Key,Definition
 :code:`observations:<observation>:shared_in_central_agent`,"Set to :code:`true` if if named :code:`<observation>` values will be common in all buildings."
 :code:`actions`,"Used to define the action space."
 :code:`actions:<action>:active`,"Set to :code:`true` if agent will provide named :code:`<action>` to environment."
-:code:`agent`,"Used tp define control algorithm to use in simulation."
+:code:`agent`,"Used to define control algorithm to use in simulation."
 :code:`agent:type`,"Control algorithm class in :py:mod:`citylearn.agents` or user-defined algorithm class path."
 :code:`agent:attributes`,"Used to define attributes/hyperparameters that are used to construct control algorithm class specified in :code:`agent:type`."
 :code:`agent:attributes:<attribute>`,"Value to set named :code:`<attribute>` to in control algorithm."
 :code:`reward_function`,"Used to define reward function to use in simulation."
 :code:`reward_function:type`,"Reward function class in :py:mod:`citylearn.reward_function` or user-defined reward function class path."
 :code:`reward_function:attributes`,"Used to define attributes/hyperparameters that are used to construct reward function class specified in :code:`reward_function:type`."
 :code:`reward_function:attributes:<attribute>`,"Value to set named :code:`<attribute>` to in reward function."
-:code:`buildings`,"Used tp define buildings to use in simulation."
+:code:`buildings`,"Used to define buildings to use in simulation."
 :code:`buildings:<building_name>`,"Used to define the attributes of a building uniquely named :code:`<building_name>`."
 :code:`buildings:<building_name>:include`,"Set to :code:`true` if :code:`<building_name>` should be included in simulation."
 :code:`buildings:<building_name>:energy_simulation`,"Filename of building data file for :code:`<building_name>`. This file must be located in :code:`root_directory`."
@@ -39,7 +39,7 @@ Key,Definition
 :code:`buildings:<building_name>:<device>:attributes:<attribute>`,"Value to set named :code:`<attribute>` of :code:`<device>` class specified in :code:`buildings:<building_name>:<device>:type`."
 :code:`buildings:<building_name>:dynamics`,"Used to define building temperature dynamics LSTM models."
 :code:`buildings:<building_name>:dynamics:<mode>`,"Used to define building temperature dynamics LSTM model for specific HVAC mode where :code:`<mode>` may be :code:`cooling` or :code:`heating`."
-:code:`buildings:<building_name>:dynamics:<mode>:type`,"temperature dynamics class in :py:mod:`citylearn.dynamics` or user-defined dynamics class path."
+:code:`buildings:<building_name>:dynamics:<mode>:type`,"Temperature dynamics class in :py:mod:`citylearn.dynamics` or user-defined dynamics class path."
 :code:`buildings:<building_name>:dynamics:<mode>:attributes`,"Used to define attributes that are used to construct :code:`buildings:<building_name>:dynamics:<mode>:type`."
 :code:`buildings:<building_name>:power_outage`,"Used to define power outage preferences and stochastic model."
 :code:`buildings:<building_name>:power_outage:simulate_power_outage`,"Whether to allow time steps when the grid is unavailable and loads must be met using only the building's flexible resources."

docs/source/overview/dataset.rst

@@ -43,7 +43,7 @@ The carbon intensity file is a :code:`.csv` file that contains CO:sub:`2` emissi
 Pricing Data File
 =================
 
-The carbon intensity file is a :code:`.csv` file that contains current time-step and forecasted electricity price time series. It is used as the source for :py:attr:`citylearn.building.Building.pricing`, which is the source for pricing related observations. The data can be sourced from specific utility providers for a desired location e.g. `Edison <https://www.sce.com/residential/rates/Time-Of-Use-Residential-Rate-Plans>`_. The file structure is shown in the snippet below:
+The pricing file is a :code:`.csv` file that contains current time-step and forecasted electricity price time series. It is used as the source for :py:attr:`citylearn.building.Building.pricing`, which is the source for pricing related observations. The data can be sourced from specific utility providers for a desired location e.g. `Edison <https://www.sce.com/residential/rates/Time-Of-Use-Residential-Rate-Plans>`_. The file structure is shown in the snippet below:
 
 .. include:: ../../../citylearn/data/citylearn_challenge_2022_phase_1/pricing.csv
     :code: text