Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

@Todo annotation #515

Closed
lars-reimann opened this issue May 28, 2022 · 2 comments · Fixed by #537
Closed

@Todo annotation #515

lars-reimann opened this issue May 28, 2022 · 2 comments · Fixed by #537
Assignees
Labels
enhancement 💡 New feature or request

Comments

@lars-reimann
Copy link
Member

lars-reimann commented May 28, 2022

Is your feature request related to a problem? Please describe

Currently there is no way to take notes about

  • updates that have to be done manually
  • annotation that might be added later.

Desired solution

Add a @Todo annotation that

  • is applicable to classes and functions (not parameters!)
  • can be used once
  • takes an arbitrary, potentially long text as input

In the generated Python code TODO comments with the text of the annotation should be added.

@lars-reimann lars-reimann added the enhancement 💡 New feature or request label May 28, 2022
@lars-reimann lars-reimann moved this to Backlog in API Editor May 28, 2022
@lars-reimann lars-reimann self-assigned this Jun 3, 2022
@lars-reimann lars-reimann moved this from Backlog to Todo in API Editor Jun 3, 2022
@lars-reimann lars-reimann moved this from Todo to In Progress in API Editor Jun 3, 2022
@lars-reimann
Copy link
Member Author

The branch 515-todo-annotation already contains the required changes to the backend.

@lars-reimann lars-reimann removed their assignment Jun 3, 2022
@lars-reimann lars-reimann moved this from In Progress to Todo in API Editor Jun 3, 2022
@lars-reimann lars-reimann linked a pull request Jun 3, 2022 that will close this issue
@Masara
Copy link
Contributor

Masara commented Jun 13, 2022

Ähnlich wie bei #517:

Summary of Changes

In src/features/annotations/annotationSlice.ts:

  • Add interface for TodoAnnotation
  • Update AnnotationStore
  • Update initialState
  • Add upsertTodo/removeTodo reducers to annotationsSlice
  • Export these two reducers
  • Add and export selectTodoAnnotation selector

In src/features/ui/uiSlice.ts:

  • Add interface for TodoUserAction
  • Update UserAction

Other:

  • Update src/features/annotations/AnnotationDropdown.tsx (sort entries alphabetically)
  • Update all places that use the AnnotationDropdown
  • Update src/features/annotations/AnnotationImportDialog.tsx; might replace the object in line 25 with the initialState from src/features/annotations/annotationSlice.ts, so we don't need to update this in the future
  • Update src/features/annotations/AnnotationView.tsx
  • Add form in src/features/annotations/forms
  • Update src/app/App.tsx to show form when corresponding user action is active
  • Add filter annotation:@todo (src/features/packageData/model/filters/filterFactory.ts and src/features/packageData/model/filters/AnnotationFilter.ts)
  • Update filter help text (src/common/FilterHelpButton.tsx)
  • Update src/features/annotatedPackageData/model/InferableAnnotation.ts
  • Update computation of number of annotations per element throughout the program (currently only heat map tags, later also Statistics View - Annotations #534)

Screenshots (if necessary)

Testing Instructions

Sorry, something went wrong.

@lars-reimann lars-reimann moved this from Todo to In Progress in API Editor Jun 13, 2022
@Masara Masara moved this from In Progress to Ready for Review in API Editor Jun 13, 2022
Repository owner moved this from Ready for Review to ✔️ Done in API Editor Jun 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement 💡 New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants