Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update python files to have an overview comment of what the file does #536

Open
2 tasks done
devjsc opened this issue Sep 30, 2024 · 0 comments
Open
2 tasks done
Assignees
Labels
a-documentation Area: Documentation - changes to the documentation only p-high Priority: High priority task s-confirmed Status: This is a confirmed issue

Comments

@devjsc
Copy link
Member

devjsc commented Sep 30, 2024

Prerequisites

  • I checked the documentation and made sure this feature does not already exist
  • I checked the existing issues to make sure this feature has not already been requested

Feature

A nice descriptive overivew/rationale for each file will give developers a clear understanding of how the framework works - it'll also benefit the fetch.ai docs team 👍

if you do (at the top, before imports)

"""
this is a top level comment, 
"""

import json
import ...

It will then be seen as the intro to the api ref in the docs:

...
a id="src.uagents.asgi"></a>

# src.uagents.asgi

this is a top level comment, it will be seen as the intro to the api ref in the docs

<a id="src.uagents.asgi.ASGIServer"></a>

## ASGIServer Objects

```python
class ASGIServer()

Additional Information (Optional)

No response

@Archento Archento added a-documentation Area: Documentation - changes to the documentation only p-high Priority: High priority task s-confirmed Status: This is a confirmed issue labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-documentation Area: Documentation - changes to the documentation only p-high Priority: High priority task s-confirmed Status: This is a confirmed issue
Projects
None yet
Development

No branches or pull requests

4 participants