Skip to content

[breaking] Comply with YARD documentation on Hash tag format#968

Merged
castwide merged 3 commits intocastwide:masterfrom
apiology:hash_fix
Jun 28, 2025
Merged

[breaking] Comply with YARD documentation on Hash tag format#968
castwide merged 3 commits intocastwide:masterfrom
apiology:hash_fix

Conversation

@apiology
Copy link
Contributor

@apiology apiology commented Jun 14, 2025

Fixes #961

This is technically a breaking change, but should be pretty safe - doesn't look like we ever parsed key types out of Hash<A, B>. Here's the spec as of 2018: 5209b49

See https://www.rubydoc.info/gems/yard/file/docs/Tags.md#hashes

@apiology apiology changed the title Comply with YARD documentation on Hash tag format [breaking] Comply with YARD documentation on Hash tag format Jun 14, 2025
@castwide
Copy link
Owner

I agree, it seems safe. I wouldn't expect anyone to depend on the currently broken behavior. It's just a big enough change to save for a minor release instead of a patch release.

@castwide castwide merged commit 8f0c8fc into castwide:master Jun 28, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Solargraph fails to determine hash value types (IntelliSense)

2 participants