Problems in the help documentation

This forum is meant for questions and discussions about the X# language and tools
Post Reply
User avatar
xinjie
Posts: 106
Joined: Wed May 20, 2020 10:05 am
Location: China
Contact:

Problems in the help documentation

Post by xinjie »

I've seen a few issues in the help documentation, some I can confirm are misrepresentations and others I can't.
I should note that I got the results by opening a console project in VS2022 and viewing its property page.

Here is the list:

1. topic: X# Compiler Options By Category
In "XBase Compatibility",-namedarguments is a misspelling, it seems to be -namedargs.

2. topic: X# Compiler Options Listed Alphabetically
original: The following compiler options are sorted by category. For an alphabetical list, see : X# Compiler Options Listed Alphabetically
should: The following compiler options are sorted by Alphabetically. For an alphabetical list, see : X# Compiler Options By Category

In addition, the descriptions of -ovf and -fovf are not entirely consistent. This may lead to misunderstanding on the part of some readers.
(Same in "X# Compiler Options By Category")

3. topic: -allowdot
original: Click the Dialect tab.
should: Click the Language tab.

original: Change the value.
should: Change "Allow DOT for instance members" value of checkbox

4. topic: -allowoldstyleassignments
original: Change the value.
should: Change "Allow Old Style assignments" Value of checkbox

5. topic: -baseaddress, -checke, -checksumalgorithm, -filealign, -highentropyva
original: Add the option in the "User-Defined Command Line options" property
should: Add the option in the "Extra Command Line options" property。
Because the original article was just a tooltip

6. topic: -debug, -errorreport
original: Click the Advanced button.
I really didn't find that button :)

7. topic: -define
original: On the Build tab, type the symbol that is to be defined in the Conditional compilation symbols box. For example, if you are using the code example that follows, just type xx into the text box.
I just found "Defines for the preprocessor". Do they mean the same thing?

8. topic: -keyfile
original: Click the Signing property page. Modify the Choose a strong name key file property.
I still can't find it :)

9. topic: -lb
original: In the Visual Objects Compatibility section, modify the Allow Late Binding property.
should: In the General section, modify the Allow Late Binding property.

10.topic: -nostddefs
original: Click the Build tab.
should: Click the Language tab.

For the identified parts, I have corrected them in the Simplified Chinese version. But for the parts that are not sure, I will still keep them.
简单的东西重复做,你能成为专家;重复的东西用心做,你能成为赢家!
User avatar
robert
Posts: 4518
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

Re: Problems in the help documentation

Post by robert »

Xinjie,
Thanks.
May I suggest that next time you create a Github issue for this?
I will do that now myself.

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
User avatar
xinjie
Posts: 106
Joined: Wed May 20, 2020 10:05 am
Location: China
Contact:

Re: Problems in the help documentation

Post by xinjie »

Robert,

Next time,OK!
简单的东西重复做,你能成为专家;重复的东西用心做,你能成为赢家!
User avatar
robert
Posts: 4518
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

Re: Problems in the help documentation

Post by robert »

Xinjie,
See https://github.com/X-Sharp/XSharpPublic/issues/1504
I have applied the changes.

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
Post Reply