sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

HTML search: adjust type signatures for custom HTML scoring

Open jayaddison opened this issue 1 year ago • 0 comments

Feature or Bugfix

  • Refactoring

Purpose

  • Adjust the type hint for the scoring argument to the IndexBuilder

Detail

  • Currently we have test coverage that provides a scoring value of None -- but the type signature we have on the class doesn't accept that, strictly speaking.
  • Adjust the type signature to accept that single additional value (since we already have test coverage for it).
  • Also: add a str type to the relevant HTML builder config value.

Relates

  • Originates from discussion in #12816.

cc @danieleades

jayaddison avatar Aug 26 '24 17:08 jayaddison