Skip to content

Comments

[Docs]: Correct README.md to match initialize declaration with string argument#2

Merged
nircoe merged 5 commits intonircoe:mainfrom
PrajwalHM-Gaargesh:bugfix/updateREADME
Aug 10, 2025
Merged

[Docs]: Correct README.md to match initialize declaration with string argument#2
nircoe merged 5 commits intonircoe:mainfrom
PrajwalHM-Gaargesh:bugfix/updateREADME

Conversation

@PrajwalHM-Gaargesh
Copy link
Contributor

Modified the initialize function declaration to accept a string parameter in README.md as per the signature of that function in section 2 of Quick start.

Modified the initialize function declaration to accept a string parameter in README.md.
@nircoe nircoe changed the title Correct README.md to match initialize declaration with string argument [Docs]: Correct README.md to match initialize declaration with string argument Aug 4, 2025
@nircoe nircoe self-requested a review August 4, 2025 21:06
Copy link
Owner

@nircoe nircoe left a comment

Choose a reason for hiding this comment

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

Great catch @PrajwalHM-Gaargesh!
I added the defaultSource argument later on and forgot to update the README!
I think you should mention in the comments where you changed that in this way (passing std::string{}) you will initialize logcoe without an default source.
It's a minor addition, but may be helpful to other users in the future.
Maybe even we should give two examples, one with a defaultSource ("logcoe" for example, so by default the logs we will printing be [timestamp] [log_level] [logcoe]: <log_message>),
and one without - [timestamp] [log_level]: <log_message>, of course it is possible to pass a source when logging, but there will be no default one.
Thanks for your contribution!

Add comments under examples to highlight the default source when a value is provided and when it's an empty string.
Copy link
Owner

@nircoe nircoe left a comment

Choose a reason for hiding this comment

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

H, Thanks for your updates.
I checked the documentations, you covered all of the appearances of logcoe::initialize() method.
Please just commit a fix to my review (minor changes, formatting issues only).
Afterwards I'll approve the PR, run the github workflows and you will be able to squash and merge.
Please make sure the squashed commit message is the PR title, and mention your changes shortly in the squashed commit message body.
Thanks again!

@nircoe nircoe merged commit bc37e0a into nircoe:main Aug 10, 2025
5 checks passed
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.

2 participants