GithubHelp home page GithubHelp logo

Comments (5)

Enselic avatar Enselic commented on August 27, 2024

Thank you for the feature request. This raises the question of what tool cargo public-api is or want to be. Do we want it to become sort of a linter? I'm not sure we want that actually. But I am open to be convinced otherwise, and am happy to discuss this.

But, wouldn't it be better to fix this in rustdoc/rustc directly? Sounds like a bug in rustdoc/rustc.

from cargo-public-api.

inikulin avatar inikulin commented on August 27, 2024

I would say it's already a linter with "deny" set of options for diffs. I'm going to fill an issue with rustdoc, but I believe it more likely a by design behaviour: those lints suppose to operate on a crate level and rustdoc doesn't really have a concept of public API for workspaces.

I would say this tool fills this gap - it allows complex rust codebases to introduce an "API surface concept" including stuff re-exported from internal or external crates and provide a toolset to work with that.

from cargo-public-api.

Enselic avatar Enselic commented on August 27, 2024

Did you have time to file an upstream issue yet?

To me, a "linter" is a tool that finds problems with a specific version of some code. So the --deny functionality we have is not linting functionality, since it applies to a two different versions of the same code. I will try to not get into a purely semantic discussion, but I still wanted to clarify what I mean by "linter".

In order to help us evaluate the use case you have in mind, would you mind providing some minimal example code please, along with how you would invoke cargo public-api and what output you expect?

from cargo-public-api.

Emilgardis avatar Emilgardis commented on August 27, 2024

something I just realised, isn't this already possible?

cargo clippy --workspace -- -D missing_docs

from cargo-public-api.

Enselic avatar Enselic commented on August 27, 2024

Closing for now. Of course feel free to re-open in case you want to keep discussing this.

from cargo-public-api.

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.