diff --git a/contrib/STYLE.md b/contrib/STYLE.md index b7ac755f..18522612 100644 --- a/contrib/STYLE.md +++ b/contrib/STYLE.md @@ -58,7 +58,7 @@ Python's official style guide is PEP 8, which provides conventions for writing c #### More details -Use `black` to format your python code before commiting for consistency across such a large pool of contributors. Black's code [style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#code-style) ensures consistent and opinionated code formatting. It automatically formats your Python code according to the Black style guide, enhancing code readability and maintainability. +Use `black` to format your python code before committing for consistency across such a large pool of contributors. Black's code [style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#code-style) ensures consistent and opinionated code formatting. It automatically formats your Python code according to the Black style guide, enhancing code readability and maintainability. Key Features of Black: diff --git a/docs/running_on_staging.md b/docs/running_on_staging.md index e282dcfc..66b824d8 100644 --- a/docs/running_on_staging.md +++ b/docs/running_on_staging.md @@ -309,7 +309,7 @@ python neurons/validator.py --netuid 1 --subtensor.chain_endpoint ws://127.0.0.1 ## 14. Set weights for your subnet -Register a validator on the root subnet and boost to set weights for your subnet. This is a necessary step to ensure that the subnet is able to receive emmissions. +Register a validator on the root subnet and boost to set weights for your subnet. This is a necessary step to ensure that the subnet is able to receive emissions. ### Register your validator on the root subnet diff --git a/docs/stream_tutorial/README.md b/docs/stream_tutorial/README.md index f213fd3a..bf14b6d1 100644 --- a/docs/stream_tutorial/README.md +++ b/docs/stream_tutorial/README.md @@ -1,5 +1,5 @@ # Bittensor Streaming Tutorial -This document is intented as a developer-friendly walkthrough of integrating streaming into your bittensor application. +This document is intended, indented as a developer-friendly walkthrough of integrating streaming into your bittensor application. If you prefer to jump right into a complete stand-alone example, see: - `miner.py` @@ -96,7 +96,7 @@ class MyStreamingSynapse(bt.StreamingSynapse): return self.completion # implement your `process_streaming_response` logic to actually yield objects to the streamer - # this effectively defines the async generator that you'll recieve on the client side + # this effectively defines the async generator that you'll receive on the client side async def process_streaming_response(self, response: MyStreamingSynapse): # this is an example of how you might process a streaming response # iterate over the response content and yield each line