Create faq.rst #282
Merged
Create faq.rst #282
Conversation
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
docs/source/faq.rst
Outdated
| .. contents:: The following is a list of common questions asked about pyOpenMS. | ||
|
|
||
| How can I wrap a new method with pyOpenMS? | ||
| ########################################### |
Contributor
There was a problem hiding this comment.
Let's follow existing formatting style guide for pyopenms-docs .rst:
Change headings formattings to the one discussed.
docs/source/faq.rst
Outdated
| How can I wrap a new class with pyOpenMS? | ||
| ######################################### | ||
|
|
||
| Create a new file ``src/pyOpenMS/pxds/CLASS_NAME.pxd`` and use the `procedure outlined <https://github.com/OpenMS/OpenMS/wiki/pyOpenMS#--wrapping-classes>`_. |
Contributor
There was a problem hiding this comment.
instead of wiki, let's link to the page on pyopenms.readthedocs.
docs/source/faq.rst
Outdated
| @@ -0,0 +1,22 @@ | |||
|
|
|||
Contributor
There was a problem hiding this comment.
let's delete this newline.
docs/source/faq.rst
Outdated
| How can I wrap a new class with pyOpenMS? | ||
| ----------------------------------------- | ||
|
|
||
| Create a new file ``src/pyOpenMS/pxds/CLASS_NAME.pxd`` and use the `procedure outlined <https://pyopenms.readthedocs.io/en/latest/wrap_classes.html?#how-pyopenms-wraps-python-classes>`_. |
Contributor
There was a problem hiding this comment.
i was not clear: let's link it to: wrap_classes.rst#how-to-wrap-new-classes
tapaswenipathak
approved these changes
May 24, 2022
Contributor
|
Missed: requires an entry here: https://github.com/OpenMS/pyopenms-docs/blob/master/docs/source/index.rst |
|
Kudos, SonarCloud Quality Gate passed!
|
Contributor
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Adding faq from wiki to pyopenms-docs.
Closes #281.