1
0
mirror of https://github.com/sasjs/core.git synced 2026-01-07 17:40:05 +00:00

fix: description for mf_abort

This commit is contained in:
Allan Bowe
2021-05-10 15:23:30 +03:00
parent 5e77494aa6
commit 3e8deda008

View File

@@ -1,23 +1,11 @@
/** /**
@file @file
@brief abort gracefully according to context @brief to be deprecated
@details Do not use directly! See bottom of explanation for details. @details We will deprecate this macro in 2022
Configures an abort mechanism according to site specific policies or the As you can see, it's not a macro function.
particulars of an environment. For instance, can stream custom
results back to the client in an STP Web App context, or completely stop
in the case of a batch run.
For the sharp eyed readers - this is no longer a macro function!! It became Use mp_abort.sas instead.
a macro procedure during a project and now it's kinda stuck that way until
that project is updated (if it's ever updated). In the meantime we created
`mp_abort` which is just a wrapper for this one, and so we recomend you use
that for forwards compatibility reasons.
@param mac= to contain the name of the calling macro
@param type= deprecated. Not used.
@param msg= message to be returned
@param iftrue= supply a condition under which the macro should be executed.
@version 9.2 @version 9.2
@author Allan Bowe @author Allan Bowe