Skip to content

Rework namespace and package index #153

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 41 commits into from
May 15, 2023
Merged

Rework namespace and package index #153

merged 41 commits into from
May 15, 2023

Conversation

florisvdh
Copy link
Member

@florisvdh florisvdh commented May 9, 2023 •
edited
Loading

Closes #133.

Mainly concentrates on implementation of ideas in #133:

  • Rename selected functions (previous names are deprecated)
  • Tune which functions are exported, or enlisted in the package index (including a commit from Detect paths #152 @JanCaha)
  • Regroup some functions from a user perspective

Comments are welcome.

florisvdh and others added 30 commits May 8, 2023 10:26
@florisvdh
Namespace update: rename qgis_detect*()
faa7e03
@florisvdh
Namespace update: rename qgis_help() to qgis_help_json()
867eeda
@florisvdh
Namespace update: rename qgis_parsed_help() to qgis_parse_help()
83b79f1
@florisvdh
Namespace update: rename qgis_use_cached_help() to qgis_using_cached_…
f24f38c 
…help()
@florisvdh
Namespace update: rename qgis_use_json*() to qgis_using_json*()
e68d350
@florisvdh
Namespace update: translate some functions to qgis_get*() *
9ebfb71 
Affected are qgis_description(), qgis_arguments() and qgis_outputs()
@florisvdh
Namespace update: rename qgis_pipe() to qgis_run_algorithm_p()
f30cd47
@florisvdh
Namespace update: rename qgis_*_clean() to qgis_clean_*()
ec492ae
@florisvdh
qgis_result_single(): don't yet drop, but deprecate for some time
17270eb
@florisvdh
Keep testing deprecated functions (qgis_result_single())
748b157
@florisvdh
Namespace update: deprecate renamed functions (that remain exported)
635798a
@florisvdh
Namespace update: don't test old-named functions; nocov
dc727e9
@florisvdh
Namespace update: don't export helpers is_windows(), is_macos()
e3b9120
@florisvdh
Namespace update: don't export helper qgis_help_json()
ab8b7fa
@florisvdh
Namespace update: don't export (or document) argument helpers *
b5319b3 
as_qgis_argument() is exported, but kept out of package index & documentation
since this generic is a helper
@florisvdh
Namespace update: export and document has_plugin()
e0d3ca2
@florisvdh
Namespace update: don't export helpers qgis_env() and assert_qgis()
5b94fc9
@florisvdh
Namespace update: don't export helper assert_qgis_algorithm()
3cb63bf
@florisvdh
Namespace update: don't export helper is_qgis_tmp_file()
eeba9ff
@florisvdh
Namespace update: don't index helper method print.qgis_result()
62d2e45
@florisvdh
Namespace update: don't export helper is_qgis_result()
6f871cc
@JanCaha @florisvdh
Namespace update: call internal function in expressions-vignette chun…
f8fbd37 
…k option"
@florisvdh
Namespace update: call internal function in tests/platform-info.R
dcb5da9
@florisvdh
Namespace update: call internal functions in some examples
be63aa9
@florisvdh
Namespace update: update some documentation (prevent warnings in R CM…
d79ae60 
…D check)
@florisvdh
Namespace update: don't document as_qgis_argument, but coercion funct…
d6bfbbb 
…ions
@florisvdh
Namespace update: don't document is_qgis_result()
6392636
@florisvdh
Output coercion functions: improve documentation
33d6598
@florisvdh
Update NAMESPACE & Rd files (roxygen2)
b639a21
@florisvdh
qgis_run_algorithm_p(): make separate documentation
03acb19
florisvdh referenced this pull request in geocompx/geocompr May 11, 2023
@jannes-m
slightly rewrite has_qgis query @Robinlovelace
0a58256
@florisvdh
Copy link
Member Author

florisvdh commented May 12, 2023 •
edited
Loading

Reference index on website shows the new regrouping (+ exports & names) of functions:

before after
Screenshot 2023-05-12 at 16-42-01 Function reference Screenshot 2023-05-12 at 16-39-16 Function reference

@florisvdh florisvdh mentioned this pull request May 15, 2023
Merged
@florisvdh florisvdh merged commit 0d83de3 into main May 15, 2023
@florisvdh florisvdh deleted the rework_namespace branch May 15, 2023 12:37
@jannes-m jannes-m mentioned this pull request May 16, 2023
Merged
@florisvdh florisvdh mentioned this pull request May 17, 2023
Closed
Robinlovelace referenced this pull request in geocompx/geocompr May 19, 2023
@jannes-m
reference qgisprocess getting started vignette, fyi @Nowosad
3e498f5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Revising the namespace

2 participants

@florisvdh @JanCaha