Add debugging.md #2620
Merged
Add debugging.md #2620
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
|
Please apply this diff to enable this page in documentation under "Tutorials" section diff --git a/docs/layout.xml b/docs/layout.xml
index d2f18bc3..724b44f2 100644
--- a/docs/layout.xml
+++ b/docs/layout.xml
@@ -17,6 +17,7 @@
<tab type="user" url="\ref indexing" visible="yes" title="Indexing"/>
<tab type="user" url="\ref timing" visible="yes" title="Timing ArrayFire"/>
<tab type="user" url="\ref configuring_environment" visible="yes" title="Configuring ArrayFire Environment"/>
+ <tab type="user" url="\ref debugging" visible="yes" title="Debugging ArrayFire Code"/>
<tab type="usergroup" url="\ref page_gfor" visible="yes" title="GFOR Usage"/>
</tab>
<tab type="modules" visible="yes" title="Functions" intro="Documentation grouped according to category:"/> |
9prady9
requested changes
Aug 22, 2019
There was a problem hiding this comment.
The entire page should basically look like a hierarchy of sections. Something like the following:
-
Using Environment Variables
-
Tips in Language Bindings
- C++
- Python
I am not sure about the tips for language bindings in here - especially python or another like rust. May be they should go into their own documentation.
b2c3b38 to
cb6c8e3
Compare
|
Thanks. Sorry for dropping the ball on this: I've been on vacation the past few days. |
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.
One of the challenges I encountered getting spun up doing stuff with ArrayFire was figuring out how to debug it. Perhaps gathering some advice about this into a document would help?
This is what I've got so far, but maybe others will have thoughts.
(I'm not sure how to incorporate the markdown into the build.)