Skip to content

autodoc follow-up enhancements and bug fixes #19249

Open
@andrewrk

Description

@andrewrk

Extracted from #19208.

  • make the panic handler reflect the failure in the user interface
  • when navigating back to search results, up+down arrow should keep working
  • redundant search results (search "format")
  • in query_exec_fallible, sorting should also check the local namespace inside the file
  • walk assign_destructure not implemented yet
  • escape URLs when rendering html (look for missing_feature_url_escape)
  • implement renderHome for multiple modules
  • struct fields: render each component separate rather than via source rendering
  • infer comptime_int constants (example: members of #std.time)
  • when global const has a type of type, categorize it as a type despite its value
  • show abbreviated doc comments in types and namespaces listings
  • show type function names as e.g. ArrayList(T)
  • enum fields should not be linkified (example: std.log.Level)
  • shrink Ast to fit the slices
  • linkification of methods (example: std.array_hash_map.ArrayHashMap.count)
  • navigating to source from a decl should scroll to the decl
  • in source view, make @imports into links, but keep same syntax highlighting
  • include struct field names and doc comments in search query matching
  • include function parameter names and doc comments in search query matching
  • instead of logging "can't index foo because it has syntax errors" put it in the UI
  • in Walk.expr() it is missing support for asm_input/asm_output nodes
  • in renderNamespace, handle an aliasing loop
  • add a history item when clicking a search result (it already works when keyboard triggered)
  • instead of "declaration not found", show the decl that can't be penetrated (example: #std.os.system.fd_t)
  • better handle indentation when rendering source code #19293

Metadata

Metadata

Assignees

No one assigned

    Labels

    autodocThe web application for interactive documentation and generation of its assets.bugObserved behavior contradicts documented or intended behaviorenhancementSolving this issue will likely involve adding new logic or components to the codebase.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions