Boa: After #326, we cannot generate documentation for the boa library

Created on 17 Apr 2020  路  4Comments  路  Source: boa-dev/boa

So, it seems that now that the CLI binary is called boa, the documentation is being output in target/doc/boa for both the binary and the library, and rustdoc just ignores the library.

So we need to either revert that PR, change the name of the library crate (to boa_core or something similar), or find a way to avoid this through configuration options.

bug documentation

Most helpful comment

I agree with @Razican I鈥檓 ok with not generating documentation for the binary, that would be my choice right now.

We can always look at other options if the binary starts to become complicated, such as boa_lib or boa_core or a build.rs

All 4 comments

Hmmm. I will look into it to find a better solution. :)

I couldn't find the solution we wanted. :(

We could:

  • disable documentation on the binary with doc = false
  • revert the changes.

I think we should revert changes.

There might be a way with build.rs but its really hacky.

What do you think? @Razican

Hmmm maybe not generating documentation for the binary makes sense. There is basically no documentation anyway, and the code is simple enough (at least for now).

Let's see what @jasonwilliams thinks.

I agree with @Razican I鈥檓 ok with not generating documentation for the binary, that would be my choice right now.

We can always look at other options if the binary starts to become complicated, such as boa_lib or boa_core or a build.rs

Was this page helpful?
0 / 5 - 0 ratings