Docs: Detect f1_keywods clashing

Created on 20 Aug 2020  路  10Comments  路  Source: dotnet/docs

This is a reminder for me to write a tool that detects f1_keywords clashing, such as the one mentioned in https://github.com/dotnet/roslyn/issues/46988

It's okay if anyone wants to do that before I get to it.

P2 Pri3 docs-experience

Most helpful comment

@Youssef1313 I'm working with @meganbradley to see if we can add a Docs validation for duplicated f1 keywords.

All 10 comments

This is a cool idea @Youssef1313

add @rloutlaw and @kexugit for known, we do have ways to check the whether the key_words are unique across the docset during building content with Docs Validation. @BillWagner @Youssef1313

@OsmondJiang I can't see any build warnings despite the existence of duplicate f1_keywords.

@OsmondJiang I can't see any build warnings despite the existence of duplicate f1_keywords.

Yes, it's not enabled for f1_keywords, you need contact with PM @meganbradley if you want to enable this feature.

Yes, it's not enabled for f1_keywords, you need contact with PM @meganbradley if you want to enable this feature.

cc: @BillWagner

Here are some clashings in the C# area:

@
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\compiler-options\response-file-compiler-option.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\tokens\verbatim.md
default
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\keywords\default.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\default.md
default_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\keywords\default.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\default.md
is_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\keywords\is.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\type-testing-and-cast.md
+_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\addition-operator.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\arithmetic-operators.md
-_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\arithmetic-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\subtraction-operator.md
&_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\bitwise-and-shift-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\boolean-logical-operators.md
^_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\bitwise-and-shift-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\boolean-logical-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\member-access-operators.md
|_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\bitwise-and-shift-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\boolean-logical-operators.md
!_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\boolean-logical-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\null-forgiving.md
()_CSharpKeyword
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\member-access-operators.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\type-testing-and-cast.md

@Youssef1313 Do those .md files have single or multiple F1 keywords?

@kexugit They can have one or more.
But the issue is the same F1 keyword existing in two files. For example !_CSharpKeyword, it appears in boolean-logical-operators.md and null-forgiving.md. This requires a Roslyn fix in addition to the docs fix.

On the other hand, the duplication of +_CSharpKeyword will probably not require Roslyn fix. Only docs fix to remove it from one of the articles.

        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\addition-operator.md
        C:\Users\Youssef1313\Desktop\docs\docs\csharp\language-reference\operators\arithmetic-operators.md

@Youssef1313 I'm working with @meganbradley to see if we can add a Docs validation for duplicated f1 keywords.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ite-klass picture ite-klass  路  3Comments

stanuku picture stanuku  路  3Comments

garfbradaz picture garfbradaz  路  3Comments

tswett picture tswett  路  3Comments

svick picture svick  路  3Comments