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

Documentation displays incorrect prompt and output formatting for Python code examples #115

Open
0xBitzz opened this issue Oct 25, 2024 · 0 comments · May be fixed by 0xBitzz/nillion-docs#1

Comments

@0xBitzz
Copy link

0xBitzz commented Oct 25, 2024

Description of the Issue
In the documentation, the Python Client Reference code example output lines, which should not be prefixed, are incorrectly displayed with HTML-encoded symbols >>> which can be confusing for users expecting standard Python formatting.

Current Display: The code example output in the documentation currently appear as follows:

>>> The length of the array is: 2

Suggested Update
Update the documentation:

  • Remove the >>> prefix from output lines.
The length of the array is: 2

Additional Context
This formatting correction would improve readability and better align with Python's official documentation on interactive examples.

0xBitzz added a commit to 0xBitzz/nillion-docs that referenced this issue Oct 25, 2024
This PR addresses and resolves Issue NillionNetwork#115, where code examples in the documentation displayed incorrect prompt and output formatting.
@0xBitzz 0xBitzz linked a pull request Oct 25, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant