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

otserv.cpp: Tidy and comment otserv #2685

Closed
wants to merge 1 commit into from

Conversation

foxrother
Copy link

Code tidying and extensive commenting.

@foxrother foxrother changed the title otserv.cpp: Tidy and comment code otserv.cpp: Tidy and comment otserv Oct 21, 2019
std::cout << ">> Loading vocations" << std::endl;
if (!g_vocations.loadFromXml()) {
startupErrorMessage("Unable to load vocations!");
return;
}

// load item data
// TODO DOC
Copy link
Member

Choose a reason for hiding this comment

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

Stripping comment in favor of a placeholder comment?
Shouldn't the todo list be resolved before you commit a PR? Especially if each PR represent a file/section already.

Copy link
Author

@foxrother foxrother Oct 21, 2019

Choose a reason for hiding this comment

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

Hey! Thanks for giving your feedback.

The stripped comment states the obvious and does not provide any additional insight.

I marked those as "TODO" because I wanted contributors (including myself) to know what are the parts that can receive more attention (including my own).
Also, would you leave a comment on something that you don't fully understand? I'd rather mark it.

I mentioned in the forums that I'm focusing on the more fundamental parts of the code base right now.
I intend to update those comments as I read their respective files, I simply can't do it in a heartbeat...

@foxrother
Copy link
Author

I hope I haven't startled anyone. 😛
I'm not trying to resist your feedback or anything, by the way...
I'm really just attempting to share some insights and experiment a bit with a healthy dose of reasonable arguments...
There's no problem if you guys don't agree with me after that's been done, I'd just like to ask you to be more explicit on what changes you'd like to be made. 😀

I'd also like to say that I'm not "moving lines around" for stats' sake.
I genuinely think that this kind of housekeeping is necessary.

@foxrother foxrother closed this Oct 28, 2019
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.

None yet

2 participants