GithubHelp home page GithubHelp logo

Comments (5)

Kyle-Ye avatar Kyle-Ye commented on June 14, 2024

Do you mean `Version.swift` in SwiftDocC repo?

The SymbolKit seems solved it in `SemanticVersion.swift`

        /**
         * The major version number.
         *
         * For example, the `1` in `1.2.3`
         */
        public var major: Int
        /**
         * The minor version number.
         *
         * For example, the `2` in `1.2.3`
         */
        public var minor: Int
        /**
         * The patch version number.
         *
         * For example, the `3` in `1.2.3`
         */
        public var patch: Int


        /// The optional prerelease version component, which may contain non-numeric characters.
        ///
        /// For example, the `4` in `1.2.3-4`.
        public var prerelease: String?

        /// Optional build metadata.
        public var buildMetadata: String?

from swift-docc.

d-ronnqvist avatar d-ronnqvist commented on June 14, 2024

There are other version formats that we may want to support, especially for non-framework targets, so we may want to be even less strict about the version information and allow any string value.

That said, the version information isn’t currently used anywhere so we could also remove it now and add it back in the future when we have a need for that information.

from swift-docc.

ktoso avatar ktoso commented on June 14, 2024

> Do you mean `Version.swift` in SwiftDocC repo?

Right yeah. That seems to be what is used when we invoke.

SwiftPM also has a good semantic version type you're free to use believe https://github.com/apple/swift-tools-support-core/blob/main/Sources/TSCUtility/Version.swift (Checked with Boris from SwiftPM team)

from swift-docc.

ktoso avatar ktoso commented on June 14, 2024

> That said, the version information isn’t currently used anywhere so we could also remove it now and add it back in the future when we have a need for that information.

I mean, the docc page should definitely show what version of a package is documented, so I don't think removal is an option really.

from swift-docc.

d-ronnqvist avatar d-ronnqvist commented on June 14, 2024

I opened a PR here that keeps the version information but removes the requirements that it's formatted a specific way. #49

That way it could be presented somewhere while still giving developers the full flexibility to use any version format that they prefer.

from swift-docc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.