Include clear, concise examples in documentation that effectively demonstrate functionality. Follow these principles for better documentation examples:
Include clear, concise examples in documentation that effectively demonstrate functionality. Follow these principles for better documentation examples:
Example of an effective documentation example:
# Good example - shows different results with before/after
from datetime import datetime
s = pl.Series("datetime", [datetime(2024, 1, 1), datetime(2024, 1, 2)])
# Original series
print(s)
# shape: (2,)
# Series: 'datetime' [datetime[μs]]
# [
# 2024-01-01 00:00:00
# 2024-01-02 00:00:00
# ]
# After replacement - shows varied results
result = s.dt.replace(year=2022)
print(result)
# shape: (2,)
# Series: 'datetime' [datetime[μs]]
# [
# 2022-01-01 00:00:00
# 2022-01-02 00:00:00
# ]
Users learn more effectively from examples than from descriptions alone. Well-constructed examples that demonstrate real usage patterns significantly improve API usability.
Enter the URL of a public GitHub repository