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

Documentation updates. Adding some developer centric docs #4807

Merged
merged 3 commits into from
Jun 28, 2024

Conversation

vipulrajan
Copy link
Contributor

There is no developer reference for the code at all. This is a small start to that. Looking into more ways of code base documentation to make things more comprehensive.


## [`Tab`](../../src/slic3r/GUI/Tab.hpp)

Refers to the pop windows that open when you click the edit preset button
Copy link
Contributor

Choose a reason for hiding this comment

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

This also refers to the options section on the sidebar (TabPrint I believe)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you are right. I corrected that. Also realized that just like TabPrint, TabPrintModel is also not a popup.


each one of these contains a collection of processes, filaments and printers respectively.\

#### Clarification Needed: It is unclear to me if `printers` contain different nozzle sizes of the same printer model or all different printers models by the same vendor or something else. Feel free to add clarification.
Copy link
Contributor

Choose a reason for hiding this comment

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

Each nozzle size is a different preset

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I also understood that PresetBundle is just a bundle of whatever presets without regard for compatibility with each other. Compatibility is taken care of later while loading the presets to the UI.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry. My previous answer wasn't very clear. The printers preset bundle contains all printer presets. It isn't sorted by nozzle size or vendor.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes. I also realized that while digging through the code earlier today. I have already made that update.

Copy link
Contributor

Choose a reason for hiding this comment

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

Each nozzle size is a different preset

I want to change this and so many other things if I'm honest. As someone relatively new to 3d printing the way slicers deal with their presets and poor override systems is really frustrating. I assume it's historic but I want one preset where some of the values will change if I just select a different nozzle.

I want to be able to say things like if this is PETG then just add some z offset. All my PETG has the same Z_ADJUST custom code.

Copy link
Owner

@SoftFever SoftFever left a comment

Choose a reason for hiding this comment

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

This is fantastic first step of documenting the dev stuff.
Thank you!

@SoftFever SoftFever merged commit 31df3f0 into SoftFever:main Jun 28, 2024
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.

4 participants