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

refactor: clean todo comments #1178

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

miurahr
Copy link
Member

@miurahr miurahr commented Nov 8, 2024

There are a couple of TODO comments in the OmegaT source.
This PR is to clean it up with updating comments, put it to issue ticket, or update javadoc.

Pull request type

Please mark github LABEL of the type of change your PR introduces:

  • Other (describe below)
    refactor

Which ticket is resolved?

What does this PR change?

  • CLIParameters: put it on document issue
  • IFilter: Explicitly explains the limitation in JavaDoc
  • LatexFilter: refactor logging as debug log
  • ProjectFactory: update comments
  • RealProject: explains in IFilter javadoc, so leave the pointer to IFilter in the comment.
  • Translator: make it public and update comment typos.
  • BaseMainWindowMenu: it is original implementer's idea to load menu from a resource bundle. remove it.

Other information

- CLIParameters: put it on document issue
- IFilter: Explicitly explains the limitation in JavaDoc
- LatexFilter: refactor logging as debug log
- ProjectFactory: update comments
- RealProject: explains in IFilter javadoc, so leave the pointer to IFilter in the comment.
- Translator: make it public and update comment typos.

Signed-off-by: Hiroshi Miura <[email protected]>
- BaseMainWindowMenu: it is original implementer's idea to load menu from a resource bundle. remove it.

Signed-off-by: Hiroshi Miura <[email protected]>
- SpellcheckerConfigurationController: update comment with a description for a future direction of the implementation.
- Extend IEditor to provide getCurrentPositionInEntryTranslationInEditor and move logic from SearchWindowController to EditorController

Signed-off-by: Hiroshi Miura <[email protected]>
- HunspellTokenizer to implement stopWords

Signed-off-by: Hiroshi Miura <[email protected]>
@miurahr
Copy link
Member Author

miurahr commented Nov 8, 2024

This becomes too big a change. I want to split and raise each as PR.

@miurahr miurahr marked this pull request as draft November 8, 2024 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant