Conversation
Contributor
|
Not a fan of this one! Those examples should be verbatim. What exactly did they break? |
Collaborator
Author
|
Okay sorry for the quick review & merge. If we want to include examples in docstrings, I recommend to use the propre Sphinx syntax. Something like: def foo():
"""summary.
:example:
.. highlight:: python
.. code-block:: python
import sys
...
""" |
Contributor
|
That would be super fancy and make sense especially when the documentation website is there. 👍 For now, would it be OK with you if we simply set those docstrings to raw strings ( |
Contributor
|
I made a new ticket for this so that we can forget about it for now :) -> #56 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Spotted by migration script to PyQt6 https://github.com/qgis/QGIS/wiki/Plugin-migration-to-be-compatible-with-Qt5-and-Qt6/