swiftlang / swift-docc-render

Web renderer for Swift-DocC documentation.
Apache License 2.0
312 stars 52 forks source link

Render availability items without version range details #891

Closed mportiz08 closed 1 month ago

mportiz08 commented 1 month ago

Bug/issue #, if applicable: 135420580

Summary

This makes the AvailabilityRange.introducedAt prop optional instead of required.

This adds support for indicating that a symbol is available on a certain platform, even if there are no additional details on the specific version of that platform when it was first introduced.

Example

For an example platform of foo, this is how it should now render:

text foo (instead of foo 2.0+)

title (hover text) Available on foo (instead of Available on foo 2.0 and later)

aria-label foo, Available on foo (same pattern of combining text/title)

Testing

Steps:

  1. Test that the availability strings work the same as today without regressions with symbols that have version details
  2. Test for the above string patterns after removing the introducedAt value from existing availability items

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

mportiz08 commented 1 month ago

@swift-ci test