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

Remove duplicate semantic versioning types #970

Open
2 tasks done
anferbui opened this issue Jun 28, 2024 · 1 comment
Open
2 tasks done

Remove duplicate semantic versioning types #970

anferbui opened this issue Jun 28, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@anferbui
Copy link
Contributor

Description

In the codebase, we have four types which we use to represent a semantic version number:

These all seem to be fulfilling a similar purpose. We should converge on using only one type throughout the DocC codebase.

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

Only one Swift type is used to represent a semantic version number in DocC. All other types are deprecated/removed.

Actual behavior

There are 4 types used to represent a semantic version number in DocC.

Steps To Reproduce

No response

Swift-DocC Version Information

f019ab8

Swift Compiler Version Information

No response

@anferbui anferbui added the bug Something isn't working label Jun 28, 2024
anferbui added a commit to anferbui/swift-docc that referenced this issue Jun 28, 2024
Uses `SemanticVersion` type rather than `VersionTriplet`. We have 4 types in DocC to represent a semantic version, and want to converge towards using only SemanticVersion:
swiftlang#970
@anferbui
Copy link
Contributor Author

Per discussion in #959, @d-ronnqvist and me think we should try to move towards converging on SemanticVersion because it's the type that is used the most in the repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant