Code Monkey home page Code Monkey logo

Comments (5)

pavoljuhas avatar pavoljuhas commented on July 17, 2024

I think we still need both "objective" and "morphed" names. "objective" is the input PDF to be morphed and after transformations becomes "morphed" data.

from diffpy.pdfmorph.

sbillinge avatar sbillinge commented on July 17, 2024

from diffpy.pdfmorph.

chloeann95 avatar chloeann95 commented on July 17, 2024

I believe this gets closed by #46 unless you want me to go through the code and change the code names used throughout as well. Indicating which file is morphed could be done better in the help menu or even in the readout where it gives morphing parameters. Could say something like "X was morphed with" prior to giving the morphing parameters to better remove ambiguity or having to search in the help menu.

from diffpy.pdfmorph.

chloeann95 avatar chloeann95 commented on July 17, 2024

I think this could be closed by #46 I added some clarity with the documentation where when it mentioned "objective" or "reference" I mark which file input it is but could go farther if we want to changed more thoroughly

from diffpy.pdfmorph.

sbillinge avatar sbillinge commented on July 17, 2024

No, this is not closed by #46. I put comments on that PR to that effect, but I can merge that PR and we can fix this on this PR. Tasks would be:

  1. Look in documentation and change everywhere objective -> morph (data will be manipulated) and `reference -> target) (data will stay unchanged).
  2. Look everywhere in code comments and make the same mapping
  3. Add words to the docs and the README.md that explains the meaning of the words
  4. This is more tricky as getting it wrong will break the code, but change all variables in the code that link to the old naming scheme to reflect the new, so xobjin -> x_morph_in or sthg. The underscores or not depend on making the code as readable and clear as possible.

Doing global searches for the terms in PyCharm and using its "refactor" capabilities should help, but double-check any global copy-replace activities. Being a bit hands-on will help

from diffpy.pdfmorph.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.