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

Reworked and moved TP guide #103

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Reworked and moved TP guide #103

wants to merge 5 commits into from

Conversation

xpqz
Copy link
Collaborator

@xpqz xpqz commented Feb 4, 2025

  • Move TP guide into the Win UI Guide.
  • Remove some unecessary screen shots
  • JD and FS review comments addressed.

References #82

@xpqz xpqz requested a review from FionaDyalog February 4, 2025 12:20

The **Next Primitive** icon is always present in the tracer. The new **<TP>** command lets you open a tracer on an expression typed directly in the session that previously could not be traced into.

## Anatomy of the TP Interface

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Anatomy of a TP Interface" section should be renamed and moved to be a sub-section of the Tracer section; it is not specific to tracing primitives (even though it happened to be implemented at the same time); the images are not necessary and add a maintenance overhead. The "Aspect Panes" section is specific to tracing primitives and should remain.

Suggested rewrite:

Display

There are three layout modes; these can be selected from the Layout menu:

  • Classic – the Tracer is detached from the Session window and can be positioned as required.
  • Debugger at the bottom – the Tracer is positioned beneath the Editor within the Session window. This is the default setting
  • Debugger on the left – the Tracer is to the left of the Editor within the Session window.

In all three modes, there are two docked, but minimised, panes named Left Argument and Right Argument. These automatically expand as you trace through an expression.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will leave this for now until we have clarity on the old/new classic modes.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image is unnecessary and should be removed

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image is unnecessary and should be removed

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image is unnecessary and should be removed


### Aspect Panes

There are several more aspects of an expression that can be inspected in TP mode beyond the left and right arguments. These are available under the **Windows** menu when in tracing mode.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested rewrite:

When tracing primitives, the Windows menu in the Tracer offers additional panes beyond the default ones for left and right arguments. These can be are divided into two sections; items 1-4 apply to the current function, and items 5-9 apply to the previously-executed function. They are:

Copy link
Collaborator Author

@xpqz xpqz Feb 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this documents the effect (additional panes) instead of the purpose (further inspection options). How about

When tracing primitives, there are several more aspects of an expression that can be inspected beyond the default ones for left and right arguments, available under the Windows menu in the Tracer. These are divided into two sections; items 1-4 apply to the current function, and items 5-9 apply to the previously-executed function. They are:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When tracing primitives, there are several more aspects of an expression that can be inspected beyond the default ones for left and right arguments. These are available under the Windows menu in the Tracer, where they are divided into two sections; items 1-4 apply to the current function, and items 5-9 apply to the previously-executed function. They are:

windows-ui-guide/docs/tracer/trace-primitives.md Outdated Show resolved Hide resolved
windows-ui-guide/docs/tracer/trace-primitives.md Outdated Show resolved Hide resolved
windows-ui-guide/docs/tracer/trace-primitives.md Outdated Show resolved Hide resolved
windows-ui-guide/docs/tracer/trace-primitives.md Outdated Show resolved Hide resolved
windows-ui-guide/docs/img/tbt-diamond3.png Outdated Show resolved Hide resolved
@FionaDyalog
Copy link

Note: the other changes needed to this document have not been included in this Pull Request (see Mantis issue for what they are).

@MaxCan-Code
Copy link

Should links like these be ![](../img/<image>.png)?

|![](img/trace-tools-exec-icon.png)|Exec|ER|Enter|Execute expression|
|![](img/trace-tools-trace-icon.png)|Trace|TC|Ctrl+Enter|Trace expression|
|![](img/trace-tools-back-icon.png)|Back|BK|Ctrl+Shift+Bksp|Go back one line|
|![](img/trace-tools-fwd-icon.png)|Fwd|FD|Ctrl+Shift+Enter|Skip current line|
|![](img/trace-tools-continue-icon.png)|Continue|BH|&nbsp;|Stop on next line of calling function|

@xpqz
Copy link
Collaborator Author

xpqz commented Feb 6, 2025

@MaxCan-Code thank you for spotting that; should be fixed in the next update I push.

<h2 class="example">Example</h2>
In a Session, enter the expression `(+/÷≢)⍳10` and start tracing primitives.

![](../../img/tp-start.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should ../../img be ../img?

Suggested change
![](../../img/tp-start.png)
![](../img/tp-start.png)

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 this pull request may close these issues.

3 participants