Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing docs that are linked to #4399

Open
coke opened this issue Nov 15, 2023 · 7 comments
Open

Missing docs that are linked to #4399

coke opened this issue Nov 15, 2023 · 7 comments
Assignees
Labels
docs Documentation issue (primary issue type) help wanted We need some help here xt Regarding current or new xt/ tests or the utils/

Comments

@coke
Copy link
Collaborator

coke commented Nov 15, 2023

✗  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.

@coke coke added docs Documentation issue (primary issue type) xt Regarding current or new xt/ tests or the utils/ and removed docs Documentation issue (primary issue type) xt Regarding current or new xt/ tests or the utils/ labels Nov 15, 2023
@finanalyst
Copy link
Collaborator

@coke The missing documentation files are

  • /type/RakuAST/VarDeclaration/Simple
  • /type/RakuAST/StatementList

@lizmat
Copy link
Collaborator

lizmat commented Dec 23, 2023

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
Copy link
Collaborator Author

coke commented Dec 23, 2023

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

@coke coke self-assigned this May 22, 2024
@coke coke added the xt Regarding current or new xt/ tests or the utils/ label May 22, 2024
@coke
Copy link
Collaborator Author

coke commented May 23, 2024

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
Copy link
Collaborator Author

coke commented May 23, 2024

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 coke changed the title rakudoc-l.rakutest fails on doc/Type/RakuAST/Doc.rakudoc Missing docs that are linked to May 23, 2024
@coke coke added the help wanted We need some help here label May 24, 2024
@coke
Copy link
Collaborator Author

coke commented May 24, 2024

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
Copy link
Collaborator Author

coke commented Jul 27, 2024

  • [1] /type/CompUnit::DependencySpecification
  • [1] /type/Distribution::Resources
  • [3] /type/X::Buf::AsStr
  • [3] /type/X::Cannot::Capture
  • [1] /type/X::Comp::AdHoc
  • [1] /type/X::IO::Flush
  • [2] /type/X::IO::Lock
  • [1] /type/X::Immutable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) help wanted We need some help here xt Regarding current or new xt/ tests or the utils/
Projects
None yet
Development

No branches or pull requests

3 participants