From 3de349a778a46e8d80d33cac8d18e0fc40524169 Mon Sep 17 00:00:00 2001 From: Samuel GOUGEON Date: Sat, 5 Dec 2020 16:47:01 +0100 Subject: [PATCH] * Bug 13855 fixed [doc]: pause() page updated & improved http://bugzilla.scilab.org/13855 New en_US page: http://bugzilla.scilab.org/attachment.cgi?id=5192 (PDF) Change-Id: Ib7e11d938ba9629edc54df4cff2bfd331e9f3745 --- scilab/CHANGES.md | 1 + .../core/help/en_US/2_control_flow/pause.xml | 102 +++++++++++++------ .../core/help/fr_FR/2_control_flow/pause.xml | 104 ++++++++++++++++---- .../core/help/ja_JP/2_control_flow/pause.xml | 100 ++++++++++++++----- .../core/help/pt_BR/2_control_flow/pause.xml | 104 +++++++++++++++----- .../core/help/ru_RU/2_control_flow/pause.xml | 102 +++++++++++++------ 6 files changed, 388 insertions(+), 125 deletions(-) diff --git a/scilab/CHANGES.md b/scilab/CHANGES.md index 9e8c116..41ea73a 100644 --- a/scilab/CHANGES.md +++ b/scilab/CHANGES.md @@ -326,6 +326,7 @@ Bug Fixes * [#13417](https://bugzilla.scilab.org/13417): `csvRead` page did not document the way to use the `range` up to the last row/column. * [#13593](https://bugzilla.scilab.org/13593): `csvRead()` did not take the `range` into account when `header` is provided. `[]` could not be used as default `range`. * [#13762](https://bugzilla.scilab.org/13762): In the `fft` page, the formula for the inverse FFT missed the 1/n normalization factor. +* [#13855](https://bugzilla.scilab.org/13855): The documentation of `pause` was not up-to-date and could be improved. * [#13985](https://bugzilla.scilab.org/13985): The display of lists was very loose and poor. * [#14033](https://bugzilla.scilab.org/14033): `x_matrix` could not edit matrices of booleans, encoded integers or text. Matrices of real or complex numbers were poorly displayed. * [#14435](https://bugzilla.scilab.org/14435): Errors were not well handled in overloaded functions. diff --git a/scilab/modules/core/help/en_US/2_control_flow/pause.xml b/scilab/modules/core/help/en_US/2_control_flow/pause.xml index 5883a24..8abf7c9 100644 --- a/scilab/modules/core/help/en_US/2_control_flow/pause.xml +++ b/scilab/modules/core/help/en_US/2_control_flow/pause.xml @@ -1,8 +1,27 @@ - + + pause - pause mode, invoke keyboard + + temporarily pauses the running execution, and allows instructions in console. + Syntax @@ -13,45 +32,63 @@ Description - Switch to the pause mode; - inserted in the code of a function, pause interrupts the execution + Switch to the pause mode. + Inserted in the code of a function, pause interrupts the execution of the function: one receives a prompt symbol which indicates - the level of the pause (e.g. -1->). The user is - then in a new workspace in which all the lower-level variables - (and in particular all the variable of the function) are available. - To return to the calling workspace enter return. + the level of the pause (e.g. -1->). + The user is then in the workspace where the pause occurs, and where all the variables + around are accessible and can be changed by hand on purpose. - In this mode, [...]=return(...) - returns the variables of the argument (...) to the calling workspace with - names in the output [...]. Otherwise, the lower-level variables - are protected and cannot be modified. + To resume the execution, enter resume. - The pause is extremely useful for debugging purposes. - - - This mode is killed by the command abort. + Enter abort to definitively stop the execution and return to the main level. + + The pause is very useful for debugging purposes. + Examples + a = 3; +--> foo(2) + "Thanks to the pause, you can investigate if 'a' has the right value" + "Values of local variables can be changed too if required." + +Type 'resume' or 'abort' to return to standard level prompt. - foo(2) - ]]> +-1-> a + a = + 44. + +-1-> a = 0; + +-1-> resume + ans = + 2. +]]> See also + debug + + halt @@ -61,17 +98,26 @@ abort - quit - - whereami - where + sleep - sleep + quit + + History + + + 6.0.0 + + The new values of local variables changed during a pause are now taken + into account when resuming the execution with resume. + + + + diff --git a/scilab/modules/core/help/fr_FR/2_control_flow/pause.xml b/scilab/modules/core/help/fr_FR/2_control_flow/pause.xml index 6ea994d..5b8d029 100644 --- a/scilab/modules/core/help/fr_FR/2_control_flow/pause.xml +++ b/scilab/modules/core/help/fr_FR/2_control_flow/pause.xml @@ -1,8 +1,27 @@ - + + pause - mode de pause, attente clavier + + suspend temporairement l'exécution en cours, et autorise les commandes en console + Syntaxe @@ -13,27 +32,66 @@ Description - Passage en mode de pause; - inséré dans le code d'une fonction, pause fait une pause dans l'exécution - de la fonction : un symbole d'invite de commande est affiché à l'utilisateur indiquant le "niveau" de la pause (e.g. -1->). L'utilisateur se trouve dans un environnement dans lequel toutes les variables du niveau correspondant sont accessibles (en particulier les variables locales de la fonction). - Pour reprendre l'exécution taper "return". + Passage en mode de pause. + Inséré dans le code d'une fonction, pause interrompt momentanément + l'exécution de la fonction et donne la main à l'utilisateur dans la console Scilab. + Une invite de commande spécifique -#-> est affichée, où # est + la profondeur d'exécution à laquelle la pause se trouve (e.g. -1->). + L'utilisateur se trouve dans un environnement dans lequel toutes les variables du niveau + correspondant sont accessibles (en particulier les variables locales de la fonction) + et peuvent si besoin être modifiées. - Dans ce mode, [...]=return(...) - renvoie les variables de l'argument (...) dans l'environnement appelant - sous les noms précisés dans [...]. Sinon, les variables de l'environnement interrompu sont protégées et non modifiables. + Pour reprendre et poursuivre l'exécution, taper resume. - L'instruction pause est très utile en phase de mise au point ou de débogage. - - - Il est possible de sortir du mode de pause en mettant fin à l'exécution en tapant "abort". + Pour sortir du mode pause et mettre fin à l'exécution, taper abort. + + L'instruction pause est très utile en phase de mise au point ou + de débogage. + + + + Exemples + + a = 3; +--> foo(2) + "En mode pause, la valeur courante de 'a' peut être vérifiée." + "La valeur des variables internes locales peuvent si besoin être modifiées." + +Type 'resume' or 'abort' to return to standard level prompt. + +-1-> a + a = + 44. + +-1-> a = 0; + +-1-> resume + ans = + 2. +]]> Voir aussi + debug + + halt @@ -43,17 +101,27 @@ abort - quit - - whereami - where + sleep - sleep + quit + + Historique + + + 6.0.0 + + Les nouvelles valeurs des variables locales modifiées durant une pause sont + désormais prises en compte lorsque l'exécution du code restant est relancée + avec resume. + + + + diff --git a/scilab/modules/core/help/ja_JP/2_control_flow/pause.xml b/scilab/modules/core/help/ja_JP/2_control_flow/pause.xml index a734ee8..62148a3 100644 --- a/scilab/modules/core/help/ja_JP/2_control_flow/pause.xml +++ b/scilab/modules/core/help/ja_JP/2_control_flow/pause.xml @@ -1,8 +1,27 @@ - + + pause - 中断モード, キーボード入力を待つ + + は実行中の実行を一時的に一時停止し、コンソールでの指示を許可します + 呼出し手順 @@ -13,45 +32,63 @@ 説明 - pauseモードに切り替えます; - 関数のコードに挿入すると,pauseは関数の実行を中断し, - pauseのレベル (例: -1->)を + pauseモードに切り替えます; + 関数のコードに挿入すると,pauseは関数の実行を中断し, + pauseのレベル (例: -1->)を 示すプロンプト記号が表示がされます. この時,ユーザは新しいワークスペースにおり, - より低いレベルの変数(特にその関数内の全ての変数)が全て利用可能となっています. - コールしたワークスペースに戻るにはreturnを入力します. + より低いレベルの変数(特にその関数内の全ての変数)が全て利用可能となっています 意図的に変更できます. - このモードでは, [...]=return(...) は - 引数の変数 (...) をコールしたワークスペースに - [...]という名前の出力として返します. - 一方, より低いレベルの変数は保護され, 修正することはできません. + To resume the execution, enter resume. - pause はデバッグの際に非常に有用です. - - - このモードはコマンド "abort"により破棄することができます. + このモードはコマンド abortにより破棄することができます. + + pause はデバッグの際に非常に有用です. + 例 + a = 3; +--> foo(2) + "Thanks to the pause, you can investigate if 'a' has the right value" + "Values of local variables can be changed too if required." + +Type 'resume' or 'abort' to return to standard level prompt. - foo(2) - ]]> +-1-> a + a = + 44. + +-1-> a = 0; + +-1-> resume + ans = + 2. +]]> 参照 + debug + + halt @@ -61,17 +98,26 @@ abort - quit - - whereami - where + sleep - sleep + quit + + 履歴 + + + 6.0.0 + + The new values of local variables changed during a pause are now taken + into account when resuming the execution with resume. + + + + diff --git a/scilab/modules/core/help/pt_BR/2_control_flow/pause.xml b/scilab/modules/core/help/pt_BR/2_control_flow/pause.xml index 70a91db..c68b1bf 100644 --- a/scilab/modules/core/help/pt_BR/2_control_flow/pause.xml +++ b/scilab/modules/core/help/pt_BR/2_control_flow/pause.xml @@ -1,8 +1,27 @@ - + + pause - modo de pausa, invoca teclado + + pausa temporariamente a execução atual e permite instruções no console. + Seqüência de Chamamento @@ -13,34 +32,64 @@ Descrição - Alterna para o modo pause ; inserido no código de - uma função, pause interrompe a execução da mesma: + Alterna para o modo pause ; inserido no código de + uma função, pause interrompe a execução da mesma: recebe-se um símbolo de prompt para indicar o nível de - pause (exemplo: -1->). O usuário + pause (exemplo: -1->). O usuário está agora num novo espaço de trabalho em que todas as variáveis de nível - infeiror (em particular todas as variáveis da função) estão disponíveis. - Para retornar ao espaço de trabalho de chamamento, entre - "return" + infeiror (em particular todas as variáveis da função) estão disponíveis + e podem ser alteradas propositalmente. - Neste modo, [...]=return(...) retorna as - variáveis dos argumentos (...) ao espaço de trabalho de - chamamento com nomes na saída [...]. Em caso contrário, - as variáveis de nível infeiror são protegidas e não podem ser - modificadas. + Para retomar e continuar a execução, entre resume. - pause é extremamente útil para propósitos de - depuramento. - - Este modo pode ser cancelado pelo comando - "abort". + Este modo pode ser cancelado pelo comando abort. + + pause é extremamente útil para propósitos de depuramento. + + + + Exemplos + + a = 3; +--> foo(2) + "Thanks to the pause, you can investigate if 'a' has the right value" + "Values of local variables can be changed too if required." + +Type 'resume' or 'abort' to return to standard level prompt. + +-1-> a + a = + 44. + +-1-> a = 0; + +-1-> resume + ans = + 2. +]]> Ver Também + debug + + halt @@ -50,17 +99,26 @@ abort - quit - - whereami - where + sleep - sleep + quit + + Histórico + + + 6.0.0 + + The new values of local variables changed during a pause are now taken + into account when resuming the execution with resume. + + + + diff --git a/scilab/modules/core/help/ru_RU/2_control_flow/pause.xml b/scilab/modules/core/help/ru_RU/2_control_flow/pause.xml index db7992c..572f915 100644 --- a/scilab/modules/core/help/ru_RU/2_control_flow/pause.xml +++ b/scilab/modules/core/help/ru_RU/2_control_flow/pause.xml @@ -1,8 +1,27 @@ - + + pause - режим паузы, вызов клавиатуры + + временно приостанавливает выполнение и разрешает инструкции в консоли. + Синтаксис @@ -13,47 +32,63 @@ Описание - Переключение в режим pause. Внесение функции pause в + Переключение в режим pause. Внесение функции pause в код функции прерывает исполнение функции: появляется символ командной строки, который - указывает уровень pause (например, -1->). + указывает уровень pause (например, -1->). Пользователь затем оказывается в новом рабочем окружении, в котором доступны все переменные - более низкого уровня (и, особенно, все переменные функции). Чтобы вернуться в вызывающее - рабочее окружение, введите команду return. + более низкого уровня (и, особенно, все переменные функции) и могут быть изменены вручную + при необходимости. - В этом режиме[...]=return(...) возвращает переменные аргумента - (...) в вызывающее рабочее окружение с именами на выходе - [...] - - . - Таким образом, переменные более низкого уровня защищены и не могут быть - изменены. - - - Команда pause чрезвычайно полезна в процессе отладки. + Чтобы продолжить выполнение, введите resume. Это режим прекращается командой abort. + + Команда pause чрезвычайно полезна в процессе отладки. + - Examples + Примеры + a = 3; +--> foo(2) + "Благодаря инструкции pause, вы можете исследовать - имеет ли 'a' верное значение." + "Значение может быть, если нужно, изменено." + + Введите «resume» или «abort» для возврата на стандартный уровень командной строки. - foo(2) - ]]> +-1-> a + a = + 44. + +-1-> a = 0; + +-1-> resume + ans = + 2. +]]> Смотрите также + debug + + halt @@ -63,17 +98,26 @@ abort - quit - - whereami - where + sleep - sleep + quit + + История + + + 6.0.0 + + Новые значения локальных переменных, изменённые в течение паузы, теперь + учитываются при возвращении с помощью resume. + + + + -- 1.7.9.5