Factor progress:none annotations

Issue #193 resolved
Dan Bonachea created an issue

As discussed in a recent informal meeting, we're a currently bit inconsistent about our presentation of UPC++ progress level: none annotations.

Two chapters (Future and Kinds) currently have a "factored statement" at the start of the API reference of the form:

UPC++ progress level for all functions in this chapter (unless otherwise noted) is: none

Those two chapters respectively have 3 and 5 "exceptions" that are "otherwise noted" as internal or user progress.

However we have other chapters (Storage and Serialization) where ALL of the functions have progress level none, and the Global Pointer chapter only has one function that is not none. Worse, we have recent examples where addition of new functions that have nothing to do with progress or communication have accidentally omitted a progress specification, resulting in ambiguity due to a lack of a "default".

I believe we have consensus to add a factored blanket statement somewhere of the form: "any library functions that don't explicitly specify a progress level have progress level none", and then delete all the explicit none annotations everywhere. This proposed change serves to highlight functions that have non-empty progress semantics.

Comments (2)

  1. Log in to comment