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

refactoring: naming and typos in code #2207

Open
zielint0 opened this issue Jul 11, 2018 · 5 comments
Open

refactoring: naming and typos in code #2207

zielint0 opened this issue Jul 11, 2018 · 5 comments
Labels

Comments

@zielint0
Copy link
Contributor

zielint0 commented Jul 11, 2018

There are many typos / errors / misspellings that

  • harm readability
  • decrease maintainability

I hope there are no obstacles to fix them (API compatibility?)

I would like to go forward and FIX them all.

@surli
Any opinions?

@surli
Copy link
Collaborator

surli commented Jul 12, 2018

I hope there are no obstacles to fix them (API compatibility?)

Actually yes this is a problem.
For me typo are the least problem we have in Spoon.
We might be more careful when reviewing the code to avoid them as much as possible, but existing typo are not harmful as long as everything is well documented.
Fixing them might led to API breaking changes that we really do not want.

I would say that the only moment we might be able to fix them is before a major release: then if we already break some things we might agree on breaking more things for a good reason.

In the meantime I'd keep the typo.

@zielint0
Copy link
Contributor Author

zielint0 commented Jul 12, 2018

@surli

Just remark: while developing software, I observed that code rot starts from small things (like typos, formatting, etc.). Then bigger flaws follow (broken window). Removing any flaws (sacrificing backward compatibility) imho pays in the long run. I know, sounds terrible! ;-)

Also, what is counterintuitive, typos have many disadvantages.

This is counter intuitive but typos in practice makes development slower (one has to learn and remember misspelled names of variables, functions, classes), make attacks easier (see Zerocoin case) and make code looking unprofessional.

@surli surli added the refactor label Jul 13, 2018
@surli surli changed the title Problem: naming and typos in code refactoring: naming and typos in code Jul 13, 2018
@zielint0
Copy link
Contributor Author

CtRole.java: ANNONYMOUS_EXECUTABLE -> ANONYMOUS_EXECUTABLE

I tried, but no luck so far.

#2219
#2220

@pvojtechovsky
Copy link
Collaborator

@zielint0 can we close this one?

@zielint0
Copy link
Contributor Author

I would like to fix few more until 2019 and close it myself.
This is not abandoned nor forgotten ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants