Docu: Adding the org.eclipse.ui.selection to core expression document#3001
Docu: Adding the org.eclipse.ui.selection to core expression document#3001vogella wants to merge 1 commit intoeclipse-platform:masterfrom
Conversation
docs/Command_Core_Expressions.md
Outdated
| | activePart | `org.eclipse.ui.IWorkbenchPart` | The active part, which can be the same as the active editor. | 3.2 | | ||
| | activePartId | `java.lang.String` | The ID of the currently active part. | 3.2 | | ||
| | activeSite | `org.eclipse.ui.IWorkbenchPartSite` | The site of the currently active part. | 3.2 | | ||
| | org.eclipse.ui.selection | Object | The current global selection if the `ESelectionService` is used. It is often used with <test/> elements with `org.eclipse.core.expressions.PropertyTester`, in programmatic core expressions, potentially with <iterate/> and <count/> elements. | 4.0 | |
There was a problem hiding this comment.
I wonder if you've previewed this? I ask because one has to be careful with markdown that looks like XML,
i.e., <test/> versus ><.
There was a problem hiding this comment.
The description was copied from one line below https://github.com/eclipse-platform/eclipse.platform.ui/pull/3001/files#diff-579451fec93073440823c9b658e9877518efbd6a40ae1ce5cfebea9a4aca105dR42
There was a problem hiding this comment.
But true, the original line also does not render well: https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Command_Core_Expressions.md
There was a problem hiding this comment.
I'm not really sure what you are trying to tell me. It doesn't really matter where it came from if it was already wrong where it come from, but probably I miss the point about. I really am not sure what is at the targets of the two link that should draw my attention.
Maybe it's more clear if I make a picture of the following two lines:
See this line is blank: " "
This line is not: "<test/> <iterate/> <count/>"
Here is what I wrote:
Here is how it renders/previews:
I'm just trying to tell you that you need to use back quotes on markup that looks like XML element tag otherwise it will disappear and we don't want that.
There was a problem hiding this comment.
@merks your feedback was clear, is valuable and will be acted upon. (as soon as I find the time). I just tried to explain how this happened; I copied an existing line (which also has the described issue).
There was a problem hiding this comment.
| | org.eclipse.ui.selection | Object | The current global selection if the `ESelectionService` is used. It is often used with <test/> elements with `org.eclipse.core.expressions.PropertyTester`, in programmatic core expressions, potentially with <iterate/> and <count/> elements. | 4.0 | | |
| | org.eclipse.ui.selection | Object | The current global selection if the `ESelectionService` is used. It is often used with `<test/>` elements with `org.eclipse.core.expressions.PropertyTester`, in programmatic core expressions, potentially with `<iterate/>` and `<count/>` elements. | 4.0 | |
There was a problem hiding this comment.
I see. 😁
I just proposed the change without having see your comment first. It's all fine other than this detail.
Also, as a general suggestion, when changing markdown, there is really no need to wait for a build. I never do. And anything that might need to be fixed can always be fixed after the fact...
vogella
force-pushed
the
core-expression-docu-update
branch
from
4fc82a8 to
84eb663
Compare
vogella
force-pushed
the
core-expression-docu-update
branch
from
84eb663 to
5b4a020
Compare
|
This looks inconsistent with respect to the other table entries: 
I guess it was never really previewed in the past: 
It would be nicer if section titles were title case: 
Do the changes need to be multiple commits or could we do them with a single commit? |
|
I will push an update of the PR for the errors I find. |
… markdown Add org.eclipse.ui.selection variable to the variables table and fix markdown rendering throughout the document by wrapping XML elements in backticks so they display correctly. Also update section titles to use title case for consistency. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
vogella
force-pushed
the
core-expression-docu-update
branch
from
5b4a020 to
f185abc
Compare
2 participants
No description provided.