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

[WIP] FILTER: Merge Colonies #620

Closed

Conversation

nyoungbq
Copy link
Contributor

@nyoungbq nyoungbq commented Jun 21, 2023

waiting on data from client

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file complex/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file complex/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch 2 times, most recently from 786b44b to bf2a88f Compare June 27, 2023 14:35
@imikejackson imikejackson force-pushed the filter/merge_colonies branch from bf2a88f to ea43fe6 Compare July 3, 2023 12:31
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch 2 times, most recently from fd477d3 to e87885b Compare July 6, 2023 12:09
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch from e87885b to dce2df9 Compare July 13, 2023 14:39
@imikejackson imikejackson changed the title FILTER: Merge Colonies [WIP] FILTER: Merge Colonies Sep 12, 2023
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch from dce2df9 to a22db01 Compare September 25, 2023 19:06
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch from a22db01 to 55fb224 Compare October 3, 2023 14:20
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch from 55fb224 to 4015f99 Compare October 10, 2023 17:00
@nyoungbq nyoungbq force-pushed the filter/merge_colonies branch from 4015f99 to 7c5dde4 Compare October 17, 2023 18:56
@nyoungbq nyoungbq closed this Jan 9, 2024
@nyoungbq nyoungbq deleted the filter/merge_colonies branch January 9, 2024 12:27
@nyoungbq
Copy link
Contributor Author

nyoungbq commented Jan 9, 2024

This filter was moved to simplnxreview until we can get data for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants