Skip to content

A0-1608 Add documentation of all public API and traits of aleph-client #832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marcin-Radecki merged 13 commits into from
Jan 5, 2023
Merged

A0-1608 Add documentation of all public API and traits of aleph-client #832

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e2d6c41
A0-1608 Add documentation of all public API and traits
Marcin-Radecki Dec 28, 2022
cc8cb39
Merge branch 'main' into A0-1608-Add-documentation-to-aleph-client
Marcin-Radecki Jan 2, 2023
4d34be0
A0-1608 Review
Marcin-Radecki Jan 2, 2023
5eebf83
A0-1608 Added basic workflow for building docs
Marcin-Radecki Jan 2, 2023
f165b8c
A0-1608 Removed redundant workflow condition
Marcin-Radecki Jan 2, 2023
84aceda
A0-1068 Review part 2
Marcin-Radecki Jan 2, 2023
2e25b6d
Merge branch 'main' into A0-1608-Add-documentation-to-aleph-client
Marcin-Radecki Jan 2, 2023
32ab76a
Merge branch 'main' into A0-1608-Add-documentation-to-aleph-client
Marcin-Radecki Jan 5, 2023
9f9df33
A0-1608 fixes after conflicts
Marcin-Radecki Jan 5, 2023
ddd173d
Merge branch 'main' into A0-1608-Add-documentation-to-aleph-client
Marcin-Radecki Jan 5, 2023
f056ae0
sneaky fix for outdated runtime data
Marcin-Radecki Jan 5, 2023
a2af7e3
revert sneaky fix
Marcin-Radecki Jan 5, 2023
06e7b2d
an ugly workaround for the fact we want to ignore rustdoc warnings in…
Marcin-Radecki Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
an ugly workaround for the fact we want to ignore rustdoc warnings in… 
… generated runtime file
  • Loading branch information
@Marcin-Radecki
Marcin-Radecki committed Jan 5, 2023
commit 06e7b2dddeb0dbee7130c317b87afedf3a050e9d
5 changes: 4 additions & 1 deletion aleph-client/docker/subxt-integration-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/usr/bin/env bash

subxt codegen --derive Clone --derive Debug --derive Eq --derive PartialEq | rustfmt --edition=2021 --config-path aleph-node/rustfmt.toml > aleph_zero.rs
# an ugly workaround for the fact we want to ignore rustdoc warnings in generated runtime file
echo "#[doc(hidden)]" > aleph_zero.rs
subxt codegen --derive Clone --derive Debug --derive Eq --derive PartialEq | rustfmt --edition=2021 --config-path aleph-node/rustfmt.toml >> aleph_zero.rs

diff -y -W 200 --suppress-common-lines aleph_zero.rs aleph-node/aleph-client/src/aleph_zero.rs
diff_exit_code=$?
if [[ ! $diff_exit_code -eq 0 ]]; then
Expand Down