close
Skip to content

docs: add Result Library requirements#1539

Merged
antonkri merged 1 commit into
eclipse-score:mainfrom
fbaeuerle:add_result_lib_reqs
Aug 15, 2025
Merged

docs: add Result Library requirements#1539
antonkri merged 1 commit into
eclipse-score:mainfrom
fbaeuerle:add_result_lib_reqs

Conversation

@fbaeuerle
Copy link
Copy Markdown
Contributor

Add requirements for the result library.

:satisfies: feat_req__baselibs__core_utilities, feat_req__baselibs__safety
:status: valid

The Result library shall operate without throwing C++ exceptions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you mean, that no C++ exception explicitly should be thrown by the library. I guess in addition the code might still need to take measures to "catch" C++ exception which might occur cause of implementation, right?

@hth9fe
Copy link
Copy Markdown
Contributor

hth9fe commented Aug 1, 2025

Do we really need a separate library for "Results"? Or would this be more likely be part of a utilities/core library?

@fbaeuerle
Copy link
Copy Markdown
Contributor Author

Do we really need a separate library for "Results"? Or would this be more likely be part of a utilities/core library?

It is part of eclipse-score/baselibs. The requirements are a documentation of the current state of implementation.

@hth9fe
Copy link
Copy Markdown
Contributor

hth9fe commented Aug 1, 2025

Do we really need a separate library for "Results"? Or would this be more likely be part of a utilities/core library?

It is part of eclipse-score/baselibs. The requirements are a documentation of the current state of implementation.

but then isn't it more a Result class and not a library?

@fbaeuerle
Copy link
Copy Markdown
Contributor Author

Do we really need a separate library for "Results"? Or would this be more likely be part of a utilities/core library?

It is part of eclipse-score/baselibs. The requirements are a documentation of the current state of implementation.

but then isn't it more a Result class and not a library?

The result class needs to interact with a few more classes that reside in baselibs/score/result, so i would argue it is an (admittedly small) library.

@github-actions
Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@antonkri antonkri merged commit 8e8891d into eclipse-score:main Aug 15, 2025
6 checks passed
@4og 4og moved this to Done in BAS - Baselibs FT Sep 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants