Skip to content

Improve method descriptions #529

@IsakNaslundBh

Description

@IsakNaslundBh

What is missing/incorrect?

#528 added initial descriptions as well as input and output attributes to methods in the UI_Engine.

That was a good start, and given the time in the milestone (just before the release) discussed with @adecler offline that they were good enough for the time being.

However, some of them ought to be improved to better state what the method is doing. for example (not fully conclusive list, most methods need to be checked):

  • the AreMatching descriptions could state how the matching is done.
  • The various Search methods could expand upon how the filtering and weighting is done,
  • Depth could indicate that it is the depth of the underlying type etc.

Agreed that next milestone might be a better time to deal with this, as there are some expected UI work in the pipeline.

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions