Re: issue-#100 Review all the existing documentation
Posted: Tue Apr 05, 2016 6:51 pm
Please remember, I still not agree about to remove the StdLogos. We may change the logo, but not remove it.
- Helmut
- Helmut
https://forum.blackboxframework.org/
You still does not give any arguments for keeping it. It was necessary when it was used in documentation. Now the logo is an image, so there is no need in StdLogos module.Zinn wrote:Please remember, I still not agree about to remove the StdLogos. We may change the logo, but not remove it.
The line "This module has a private interface, it is only used internally." is removed in Docu of Log.Ivan Denisov wrote:I am suggesting everybody to find the time until weekend to suggest final changes to the Docu and then in the weekend I will try to incorporate the texts in the topic branch.
see http://forum.blackboxframework.org/view ... =419#p3634Ivan Denisov wrote:You still does not give any arguments for keeping it. It was necessary when it was used in documentation. Now the logo is an image, so there is no need in StdLogos module.Zinn wrote:Please remember, I still not agree about to remove the StdLogos. We may change the logo, but not remove it.
The current docu of Log IMHO is pretty confusing for the normal user.Zinn wrote:The line "This module has a private interface, it is only used internally." is removed in Docu of Log.Ivan Denisov wrote:I am suggesting everybody to find the time until weekend to suggest final changes to the Docu and then in the weekend I will try to incorporate the texts in the topic branch.
Is module Log now available for normal use?
What is the different between Log and StdLog?
When should I use Log and when should I use StdLog?
- Helmut
Opinion is not an argument. Robert also did not give any arguments.Zinn wrote:see http://forum.blackboxframework.org/view ... =419#p3634Ivan Denisov wrote:You still does not give any arguments for keeping it. It was necessary when it was used in documentation. Now the logo is an image, so there is no need in StdLogos module.Zinn wrote:Please remember, I still not agree about to remove the StdLogos. We may change the logo, but not remove it.
- Helmut
Perhaps you are right. What is the new logo, a .png or .jpeg? How is in included in Docus? Does each Docu include a separate copy of the bitmap?Ivan Denisov wrote:Now the logo is an image, so there is no need in StdLogos module. Robert also did not give any arguments.
Now the logo is used only once in About dialog. It is inserted as bitmap view. If we should insert Logo in many documents I agree with your argument about space reduction and easy logo replacement. Does it necessary to insert Logo in many places?Robert wrote:Perhaps you are right. What is the new logo, a .png or .jpeg? How is in included in Docus? Does each Docu include a separate copy of the bitmap?Ivan Denisov wrote:Now the logo is an image, so there is no need in StdLogos module. Robert also did not give any arguments.
I was imagining that the new logo would be a custom View - implemented in a new version of StdLogos - and that its Restore would use the contents of some bitmap file rather than comprising many WinApi drawing calls. That way there would only be one copy of the bitmap on file, or in memory, and that it could be updated, if necessary, by only making one change.
Good text!Josef Templ wrote:Module Log provides an abstract interface for logging. It can be used for logging in low-level modules that cannot import StdLog directly due to cyclic imports. The logging features are the same as for StdLog except that any logging before the installation of the logging hook is silently ignored. During the normal startup of BlackBox StdLog is loaded and installs a logging hook. In principle, it would also be possible to support other logging devices such as a console, a file, or a remote server by means of appropriate implementations of the logging hook.
Let's be honest. I do not think, that any time we would change the Log module.Josef Templ wrote:By making a private module (Log) available for the normal user,
we introduce the obligation to document it properly and
keep it stable in the future. By keeping it in the private part
we have more freedom in the future.