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

Introduce alternative methods for the methods that have redundancy/lengthy names. #127

Closed
kazunarikudo opened this issue Mar 17, 2020 · 0 comments
Labels
compatibility An issue that affects compatibility improvement New feature or improvement
Milestone

Comments

@kazunarikudo
Copy link
Member

kazunarikudo commented Mar 17, 2020

Is your feature request related to a problem? Please describe.
Some method names are redundant or lengthy. For example:

  • Harvester
    • cti_files
    • add_cti_file()
    • remove_cti_file()
    • remove_cti_files()
    • update_device_info_list()
  • ImageAcquirer
    • is_acquiring_images()
    • start_image_acquisition()
    • stop_image_acquisition()

Describe the solution you'd like
Introduce alternative method names for those ones. For example:

  • Harvester
    • cti_files ---> files
    • add_cti_file() ---> add_file()
    • remove_cti_file() ---> remove_file()
    • remove_cti_files() ---> remove_files()
    • update_device_info_list() ---> update()
  • ImageAcquirer
    • is_acquiring_images() ---> is_acquiring()
    • start_image_acquisition() ---> start_acquisition()
    • stop_image_acquisition() ---> stop_acquisition()

The original methods are kept for the existing users but will be deleted at a future release. In the meantime, the original methods must explicitly tell users that they are using methods to be deprecated.

Describe alternatives you've considered
None.

Additional context
None.

@kazunarikudo kazunarikudo changed the title Reserved Introduce alternative methods for the methods that have redundancy/lengthy names. Mar 25, 2020
@kazunarikudo kazunarikudo added improvement New feature or improvement compatibility An issue that affects compatibility labels Mar 25, 2020
@kazunarikudo kazunarikudo added this to the 1.1.1 milestone Mar 25, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
@kazunarikudo kazunarikudo modified the milestones: 1.1.1, 1.2.0 Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 26, 2020
kazunarikudo added a commit that referenced this issue Mar 27, 2020
kazunarikudo added a commit that referenced this issue Apr 1, 2020
Updated README and the source for documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compatibility An issue that affects compatibility improvement New feature or improvement
Projects
None yet
Development

No branches or pull requests

1 participant