Page 1 of 2

Documentation errors in CommStream & Dialog

Posted: Tue Mar 07, 2017 9:36 am
by Zinn
1. CommStreams

In the line
PROCEDURE (l: Listener) LocalAdr
is missing (): Adr
PROCEDURE (l: Listener) LocalAdr (): Adr

2. Dialog

PROCEDURE ShowParamMsg (IN str, p0, p1, p2: ARRAY OF CHAR)
PROCEDURE ShowMsg PROCEDURE (IN str: ARRAY OF CHAR)

On both procedures the Pre definition

Pre
LEN(str$) # NIL 20

is wrong. Right is

Pre
str # "" 20

- Helmut

Re: Documentation errors in CommStream & Dialog

Posted: Tue Mar 07, 2017 12:37 pm
by Josef Templ
Zinn wrote:1. CommStreams

In the line
PROCEDURE (l: Listener) LocalAdr
is missing (): Adr
PROCEDURE (l: Listener) LocalAdr (): Adr
- Helmut
Right.
Zinn wrote: 2. Dialog

PROCEDURE ShowParamMsg (IN str, p0, p1, p2: ARRAY OF CHAR)
PROCEDURE ShowMsg PROCEDURE (IN str: ARRAY OF CHAR)

On both procedures the Pre definition

Pre
LEN(str$) # NIL 20

is wrong. Right is

Pre
str # "" 20
- Helmut
Keyword PROCEDURE appears twice for ShowMsg.
I cannot find "LEN(str$) # NIL 20" in 1.7.1.
Are you referring to your CPC version?

- Josef

Re: Documentation errors in CommStream & Dialog

Posted: Tue Mar 07, 2017 1:44 pm
by Zinn
Josef, your are right. I miss the last change in Dialog. Now this part of Dialog is identical
- Helmut

issue-#152 Documentation errors in CommStreams and Dialog

Posted: Fri Mar 10, 2017 9:11 am
by Josef Templ
I have created issue-#152 for fixing the docu errors reported by Helmut.

For the issue see https://redmine.blackboxframework.org/issues/152.

For the changes see https://redmine.blackboxframework.org/p ... 09ddc6ad20.

- Josef

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Mon Mar 20, 2017 5:43 pm
by Ivan Denisov
I found one extra line

Code: Select all

PROCEDURE SetCurrentPath (target: BOOLEAN)
in System/Docu/Controllers at the end of the text.
Can we join this this issue with removing of this extra line?

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Tue Mar 21, 2017 6:33 am
by Josef Templ
joined.

See diffs at https://redmine.blackboxframework.org/p ... 26aaab4f33.

It turned out to be a little more than just removing the replicated line.

- Josef

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Thu Mar 23, 2017 9:39 pm
by Robert
Is this ready for voting?

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Fri Mar 24, 2017 3:23 am
by Ivan Denisov
Robert wrote:Is this ready for voting?
I think, yes.

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Wed Mar 29, 2017 7:36 pm
by Zinn
You correct in the Docu of Dialog the line
PROCEDURE ShowMsg PROCEDURE (IN str: ARRAY OF CHAR)
to
PROCEDURE ShowMsg (IN str: ARRAY OF CHAR)

but you forgot to correct the line
PROCEDURE ShowStatus PROCEDURE (IN str: ARRAY OF CHAR)
to
PROCEDURE ShowStatus (IN str: ARRAY OF CHAR)

- Helmut

Re: issue-#152 Documentation errors in CommStreams and Dialo

Posted: Thu Apr 06, 2017 4:57 pm
by Ivan Denisov
Zinn wrote:You correct in the Docu of Dialog the line
PROCEDURE ShowMsg PROCEDURE (IN str: ARRAY OF CHAR)
to
PROCEDURE ShowMsg (IN str: ARRAY OF CHAR)

but you forgot to correct the line
PROCEDURE ShowStatus PROCEDURE (IN str: ARRAY OF CHAR)
to
PROCEDURE ShowStatus (IN str: ARRAY OF CHAR)

- Helmut
I made this small fix
https://redmine.blackboxframework.org/p ... 0e7fc24030

I think, that there is no reason for revote, because we already voted for this.

The version with the fix:
http://blackboxframework.org/unstable/m ... a1.837.zip