Skip to content

Commit 77a96a3

Browse files
authored
Fix broken documentation for v3 (#162)
1 parent f992a62 commit 77a96a3

6 files changed

Lines changed: 12 additions & 6 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ jobs:
183183
working-directory: www
184184
- name: cd lib/v3 && cargo +nightly doc
185185
env:
186-
RUSTDOCFLAGS: --deny=warnings
186+
RUSTDOCFLAGS: --deny=warnings --cfg=docsrs
187187
run: cargo +nightly doc
188188
working-directory: lib/v3
189189
- name: cd lib && cargo +nightly doc

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015-2020 Julien Cretin
4-
Copyright (c) 2017-2020 Google Inc.
3+
Copyright (c) 2015 Julien Cretin
4+
Copyright (c) 2017 Google Inc.
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy
77
of this software and associated documentation files (the "Software"), to deal

lib/v3/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## 0.1.3-git
4+
5+
### Patch
6+
7+
- Use `doc_cfg` instead of `doc_auto_cfg`
8+
39
## 0.1.2
410

511
### Patch

lib/v3/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "data-encoding-v3"
3-
version = "0.1.2"
3+
version = "0.1.3-git"
44
license = "MIT"
55
edition = "2024"
66
rust-version = "1.85"

lib/v3/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#![doc = ""]
33
#![doc = include_str!("../README.md")]
44
#![no_std]
5-
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
5+
#![cfg_attr(docsrs, feature(doc_cfg))]
66

77
#[cfg(feature = "alloc")]
88
extern crate alloc;

xtask/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ impl Action {
146146
&[&["--no-default-features", "--features=alloc"], &["--no-default-features"]];
147147
}
148148
}
149-
if self.dir == Dir::Lib && self.task == Task::Doc {
149+
if matches!(self.dir, Dir::LibV3 | Dir::Lib) && self.task == Task::Doc {
150150
instructions.0[0].env[0].1.push_str(" --cfg=docsrs");
151151
}
152152
if self.dir == Dir::Nostd && self.task == Task::Test {

0 commit comments

Comments
 (0)