Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix Documentation Inconsistency in Joke Class Example (#356)
# Fix Documentation Inconsistency in Joke Class Example This pull request addresses an inconsistency found in the `Joke` class example within the README file of the `outlines` repository. The changes ensure that the inline documentation correctly reflects the actual output format. ## Changes Made - Updated the `Joke` class definition to use `Field` descriptors for `joke` and `explanation` attributes. ## Issue Identified The previous version of the README included an example where the `Joke` class did not use `Field` descriptors, leading to a discrepancy between the class definition and the output format described in the comments. This could potentially cause confusion for users trying to understand the expected behavior of the `joke_ppt` function. ## Resolution By introducing `Field` descriptors in the `Joke` class, the documentation now accurately reflects the structure and output format of the `joke_ppt` function, enhancing clarity and correctness. I believe these updates will make the documentation more accurate and helpful for users. Your feedback and further suggestions are always welcome. Thank you for considering this pull request.
- Loading branch information