13059350773
83%

Ran 30 Jan 2025 07:05PM UTC

Jobs 1

Files 34

Run time 1min

Badge

Embed ▾

Committed 30 Jan 2025 07:02PM UTC coverage: 78.501% (-0.04%) from 78.544%

Build # 13059350773

Build Type

push

github

Committed by

web-flow

Commit Message

Clean up feature/module documentation with docs.rs features  (#518)

run with `RUSTDOCFLAGS="--cfg docsrs" cargo doc --all-features --open`

- match `send` module feature gating to `receive` module gating. I like
this because it makes what's available explicit, and hides stuff you
don't want in the default configuration, but I could understand removing
if it seems like excessive complexity in cfging (API changing)
- Put explicit feature labels on optional modules with `cfg_attr` (this
needs the RUSTDOCFLAGS)
- Remove public feature-specific content-type consts. They're
encapsulated in the state machine now. (API changing)
- remove obsolete base64 re-export since our state machine covers it.
(API changing)
- Add module docs to public modules without fuss 
- Get rid of feature switching in doc strings.

Discovered these flaws with docs in while addressing #504.

Run Details

3644 of 4642 relevant lines covered (78.5%)

990.19 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
2	93.79	-0.59%	payjoin/src/send/mod.rs

Jobs

ID	Job ID	Ran	Files	Coverage
1	13059350773.1	30 Jan 2025 07:05PM UTC	34	78.5	GitHub Action Run

payjoin / rust-payjoin / 13059350773
83%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 13059350773

payjoin / rust-payjoin / 13059350773 83%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 13059350773

payjoin / rust-payjoin / 13059350773
83%

README BADGES
x