processing / processing/processing-website

Surface methods should be replaced by new core methods in the reference

Open
#335 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Help Wanted Reference
Dominant language
MDX
Stars
90
Forks
122
Avg merge
1h 43m
Merged PRs (30d)
3

Description

Processing 4 added new core functions to replace the surface methods as can be seen in the Beta 5 and Beta 7 release notes. These changes are also mentioned here https://github.com/processing/processing4/issues/53

The reference needs to be updated to reflect those updates:

  • windowResize(w, h) replaces surface.setSize(w, h)
  • windowResizable() replaces surface.setResizable() (reference)
  • windowMove(x, y) replaces surface.setLocation(x, y) (reference)
  • windowTitle() replaces surface.setTitle() (reference)
  • new windowResized() event handler
  • new windowMoved() event handler

In case you want to contribute to this task, here is how to edit the reference.

Note: surface methods are still backwards compatible but you are encouraged to use the new methods for future sketches

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/reference.md and the linked reference pages for setResizable, setLocation, and setTitle. Update the reference to describe the six listed window methods and event handlers, then verify that every checklist item is covered and the legacy surface methods are identified as backward compatible.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.