issue-#152 Documentation errors in CommStreams and Dialog

Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

Documentation errors in CommStream & Dialog

Post 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
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: Documentation errors in CommStream & Dialog

Post 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
Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

Re: Documentation errors in CommStream & Dialog

Post by Zinn »

Josef, your are right. I miss the last change in Dialog. Now this part of Dialog is identical
- Helmut
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

issue-#152 Documentation errors in CommStreams and Dialog

Post 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
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

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

Post 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?
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

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

Post 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
User avatar
Robert
Posts: 1024
Joined: Sat Sep 28, 2013 11:04 am
Location: Edinburgh, Scotland

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

Post by Robert »

Is this ready for voting?
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

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

Post by Ivan Denisov »

Robert wrote:Is this ready for voting?
I think, yes.
Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

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

Post 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
Ivan Denisov
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

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

Post 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
Post Reply