search

Raku / doc

🦋 Raku documentation
https://docs.raku.org/
Artistic License 2.0
292 stars 291 forks source link

Missing docs that are linked to #4399

Open coke opened 1 year ago

coke commented 1 year ago 
✗  xt/rakudoc-l.rakutest doc/Type/RakuAST/Doc.rakudoc
1..1
# Subtest: doc/Type/RakuAST/Doc.rakudoc
    ok 1 - /type/RakuAST/Doc/Block exists (primary)
    ok 2 - /type/RakuAST/Doc/Markup exists (primary)
    not ok 3 - /type/RakuAST/StatementList exists (primary)
    # Failed test '/type/RakuAST/StatementList exists (primary)'
    # at xt/rakudoc-l.rakutest line 63
    ok 4 - /type/RakuAST/Doc/Paragraph exists (primary)
    ok 5 - /type/RakuAST/Doc/Markup exists (primary)
    ok 6 - /type/RakuAST/Doc/Declarator exists (primary)
    ok 7 - /type/RakuAST/Doc/DeclaratorTarget exists (primary)
    not ok 8 - /type/RakuAST/VarDeclaration/Simple exists (primary)
    # Failed test '/type/RakuAST/VarDeclaration/Simple exists (primary)'
    # at xt/rakudoc-l.rakutest line 63
    1..8
    # You failed 2 tests of 8
not ok 1 - doc/Type/RakuAST/Doc.rakudoc
# Failed test 'doc/Type/RakuAST/Doc.rakudoc'
# at xt/rakudoc-l.rakutest line 89
# You failed 1 test of 1

Indicates that we have links to type documentation that hasn't been implemented yet.

finanalyst commented 1 year ago

@coke The missing documentation files are

lizmat commented 1 year ago

These have not been written. And since the API isn't fixed yet, will not be written at this stage:

Three solutions:

  1. ignore this error message
  2. remove the links causing these messages
  3. put in document stubs

Perhaps 3 is the best solution moving forward?

coke commented 1 year ago

I'll todo these specific links, no changes to docs needed

coke commented 8 months ago

Added some diagnostic output, here are current missing links with a count

Mon May 27 13:49:26 EDT 2024
# Listing by link
# [1] /type/X::Str::Match::x
# [1] /type/X::Numeric::CannotConvert
# [1] /type/Distribution::Resources
# [3] /type/X::Buf::AsStr
# [1] /type/X::Immutable
# [1] /type/X::Comp::AdHoc
# [2] /type/X::IO::Lock
# [1] /type/X::Numeric::DivideByZero
# [1] /type/X::IO::Flush
# [1] /type/CompUnit::DependencySpecification
# [3] /type/X::Cannot::Capture
coke commented 8 months ago

Instead of having links that are whitelisted to be OK to be 404s, will remove the links to the not-yet-complete RakuAST docs. (the whitelist should be on the test forcing it to be a link, not the one checking to see if target page exists)

coke commented 8 months ago

Related to #4476, but these are findable inside the repo itself so we don't need to do a build on the new-raku site

coke commented 5 months ago