Maintain consistent documentation formatting to ensure proper rendering and readability. Follow these key practices:
1. **Consistent code output display**: Standardize how objects are printed in examples. Either use `print(
Maintain consistent documentation formatting to ensure proper rendering and readability. Follow these key practices:
Consistent code output display: Standardize how objects are printed in examples. Either use print(<inst>)
or print(repr(<inst>))
consistently throughout the documentation.
Example of proper markdown list formatting with code:
- List item with code example:
```python
from pydantic import BaseModel
class Example(BaseModel):
field: str
print(Example(field="value"))
```
Following these standards will prevent broken documentation rendering and maintain a consistent look and feel throughout the codebase.
Enter the URL of a public GitHub repository