Skip to content
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.

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

READY (willbe): add readme.headers.generate command #1146

Merged
merged 8 commits into from
May 31, 2024
Merged

READY (willbe): add readme.headers.generate command #1146

merged 8 commits into from
May 31, 2024

Conversation

SRetip
Copy link
Contributor

@SRetip SRetip commented Feb 26, 2024

Add new command ( aggregation of readme.modules.headers.generate & readmde.header.generate )

use crate::path::AbsolutePath;

/// Aggregates two commands: `generate_modules_headers` & `generate_main_header`
pub fn readme_headers_generate( ( _, _ ) : ( wca::Args, wca::Props ) ) -> Result< () >
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

report!

@Wandalen Wandalen changed the title READY (willbe): add readme.headers.generate command NOT READY (willbe): add readme.headers.generate command Feb 26, 2024
@Wandalen
Copy link
Owner

@SRetip get completed

@Wandalen
Copy link
Owner

what is with this? @SRetip

@SRetip
Copy link
Contributor Author

SRetip commented May 14, 2024

what is with this? @SRetip

I can't complete this

@SRetip SRetip changed the title NOT READY (willbe): add readme.headers.generate command READY (willbe): add readme.headers.generate command May 30, 2024
Copy link
Contributor

@Barsik-sus Barsik-sus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me 👍

But look through the messages below and make sure everything is okay

@@ -114,21 +178,40 @@ mod private
/// [![docs.rs](https://raster.shields.io/static/v1?label=docs&message=online&color=eee&logo=docsdotrs&logoColor=eee)](https://docs.rs/wtools)
/// <!--{ generate.main_header.end }-->
/// ```
pub fn readme_header_renew( path : AbsolutePath ) -> Result< () >
pub fn readme_header_renew( path : AbsolutePath ) -> Result< MainHeaderRenewReport, ( MainHeaderRenewError, MainHeaderRenewReport ) >
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to swap the error and report to follow the sequence of the other commands, wouldn't it?

{
use std::fmt::{Display, Formatter};
use error_tools::{ Result, err };
use crate::_path::AbsolutePath;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be not in line with the convention

use error_tools::{ Result, err };
use crate::_path::AbsolutePath;
use crate::action;
use crate::action::{MainHeaderRenewReport, ModulesHeadersRenewReport};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing spaces

{
report.main_header_renew_report = r;
}
Err( ( error, r) ) =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Err( ( error, r) ) =>
Err( ( error, r ) ) =>

{
report.modules_headers_renew_report = r;
}
Err( ( error, r) ) =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Err( ( error, r) ) =>
Err( ( error, r ) ) =>

@SRetip SRetip changed the title READY (willbe): add readme.headers.generate command NOT READY (willbe): add readme.headers.generate command May 31, 2024
@SRetip SRetip requested review from Barsik-sus and Wandalen May 31, 2024 07:01
@SRetip SRetip changed the title NOT READY (willbe): add readme.headers.generate command READY (willbe): add readme.headers.generate command May 31, 2024
@Wandalen Wandalen merged commit 6f00d47 into Wandalen:alpha May 31, 2024
1 of 4 checks passed
@SRetip SRetip deleted the readme_headers_generate branch June 3, 2024 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants