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.

Sign up for GitHub

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

Jump to bottom

Add comments to components #9162

Closed
2 of 4 tasks
AdRiley opened this issue Feb 23, 2024 · 5 comments · Fixed by #9230
Closed
2 of 4 tasks

Add comments to components #9162

AdRiley opened this issue Feb 23, 2024 · 5 comments · Fixed by #9230
Assignees
@kazcw
Labels
-gui p-high Should be completed in the next sprint x-new-feature Type: new feature request
Milestone
Beta Release

Comments

@AdRiley
Copy link
Member

AdRiley commented Feb 23, 2024 •
edited by kazcw
Loading

This story adds the ability to display one line comments for components in the GUI.

That is comments that are stored in the enso file like so:

## add a row number so I can use it for my transpose
operator20253 = operator95608.add_row_number

It should appear in the GUI the same as the error dialog, but positioned above the component

image

As always please don't take my poor artwork as anything more than an indicator of the idea. Fonts, sizing, spacing etc. should match existing standards.

  • New comments can be added using a new menu item on the full wheel
  • New menu item should be top right (North-East) on the wheel (so next to where the comment appears)
  • Comment should be spaced to not overlap with the full wheel
  • If a comment already exists the menu item button will put the comment in edit mode
  • Comment can also enter edit mode by Ctrl-clicking on the comment
  • If a user deletes all the text in a comment and then exits edit mode the comment should be removed

Tasks
Beta Give feedback
  1. Display comments #9218
    -gui CI: No changelog needed CI: Ready to merge
    kazcw
  4. Create and edit comments #9230
    -gui CI: No changelog needed
    kazcw
@AdRiley AdRiley added p-high Should be completed in the next sprint x-new-feature Type: new feature request -gui labels Feb 23, 2024
@AdRiley AdRiley added this to the Beta Release milestone Feb 23, 2024
@somebody1234
Copy link
Contributor

i assume Ctrl+Click should also put the comment into edit mode, for consistency with nodes?

@AdRiley
Copy link
Member Author

AdRiley commented Feb 23, 2024

i assume Ctrl+Click should also put the comment into edit mode, for consistency with nodes?

Yes good call. In fact I think it should probably only be Ctrl+Click for consistency with nodes. Will update story.

@farmaazon farmaazon moved this from ❓New to 📤 Backlog in Issues Board Feb 23, 2024
@farmaazon
Copy link
Contributor

Refinement notes:

  • To simplify, let's keep comments on the same layer as the node.
  • Display entire content as plain HTML. When editing, let's use codemirror to allow multiline edits.
  • For now, just display documentation code as-is, and parse the edit result.

@kazcw kazcw mentioned this issue Feb 28, 2024
Merged
5 tasks
@kazcw kazcw self-assigned this Feb 28, 2024
@kazcw kazcw moved this from 📤 Backlog to 🔧 Implementation in Issues Board Feb 28, 2024
@enso-bot enso-bot bot mentioned this issue Feb 28, 2024
Closed
2 tasks
mwu-tow pushed a commit that referenced this issue Feb 28, 2024
@kazcw
Represent documentation in AST, load into Node (#9205)
97033a2 
Part of #9162.

- Add support for representing and interpreting the full text-literal/documentation syntax (escape codes, platform-independent newlines, string interpolations); build on generalized operations for structured-fields that will simplify future representation of other types like `Vector`.
- Load parsed and interpreted node documentation into `Node`s.
@kazcw kazcw changed the title Add one line comments to components Add comments to components Feb 28, 2024
@kazcw kazcw mentioned this issue Feb 28, 2024
Merged
5 tasks
@enso-bot
Copy link

enso-bot bot commented Feb 28, 2024

Keziah Wesley reports a new STANDUP for today (2024-02-28):

Progress: Implemented documentation sync and displaying docs. Fixed a AST soundness hole related to a Y.Js invariant. It should be finished by 2024-03-05.

Next Day: Next day I will be working on the #9162 task. Editing docs.

mergify bot pushed a commit that referenced this issue Feb 29, 2024
@kazcw
Display comments (#9218)
b027a7e 
Introduce basic display of node documentation-comments.

![image](https://github.com/enso-org/enso/assets/1047859/b1960097-d265-4d77-a924-fd3c309dc3fd)

Part of #9162.

# Important Notes
- Add synchronization of `documentation` updates to the GraphDB; add a type assertion that ensures `Node` synchronization is updated when new fields are added to `Node`.
- Introduce read-only comment rendering.
@kazcw kazcw mentioned this issue Feb 29, 2024
Merged
5 tasks
@kazcw kazcw linked a pull request Feb 29, 2024 that will close this issue
Create and edit comments #9230
Merged
5 tasks
@kazcw kazcw moved this from 🔧 Implementation to 👁️ Code review in Issues Board Mar 1, 2024
@github-project-automation github-project-automation bot moved this from 👁️ Code review to 🟢 Accepted in Issues Board Mar 1, 2024
@enso-bot
Copy link

enso-bot bot commented Mar 1, 2024

Keziah Wesley reports a new STANDUP for yesterday (2024-02-29):

Progress: Implemented creating/editing/removing comments. It should be finished by 2024-02-29.

Next Day: Next day I will be working on the #9162 task. Pick something from backlog.

@farmaazon farmaazon moved this from 🟢 Accepted to 🗄️ Archived in Issues Board Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kazcw kazcw

Labels
-gui p-high Should be completed in the next sprint x-new-feature Type: new feature request
Projects
Issues Board
Archived in project
Milestone
Beta Release
Development

Successfully merging a pull request may close this issue.

Create and edit comments enso-org/enso
4 participants
@kazcw @AdRiley @farmaazon @somebody1234