Comments (3)
@uniqueg should I go ahead with this recommended styling for docstrings?
from foca.
@uniqueg can you elaborate what all methods are private? Also, the idea is to hide them and not document within the docs?
from foca.
Never really saw that comment @kushagra189: I think we would want to "hide" everything that the users don't really need. So what do they need to know about:
foca.foca.foca()
function: to understand the main entry point into FOCAfoca.models.config
module: to understand how to write the config filefoca.utilities
subpackage: to see what useful functions they can import and reuse
I think everything else can be skipped from the API docs. As for how to skip them: I would probably not completely hide them, but change the table of contents in API docs so that only these are visible from the start. It would probably still be good to leave everything else in, perhaps under a link "complete API documentation" or so, as it is still useful for FOCA developers (and sometimes app developers, too, if there are some bugs/issues).
from foca.
Related Issues (20)
- Refactor Access Control HOT 2
- Running `mypy` and fix existing code smells
- Add support for mypy in the CI CD pipeline HOT 2
- Implement configurable identifiers for access control HOT 2
- Fix ignored `mypy` errors
- Implement access control config as a part of security configuration
- Implement client for default permission endpoints HOT 2
- Implement access control config client to setup default permissions in `petstore` HOT 1
- Self assigning owner permissions for a given resource HOT 1
- bug: Read the Docs build fails
- Create/publish release 0.10.0 HOT 1
- Update workflow action versionsets
- Feature enhancement ft. access control HOT 1
- Rethink storage of modified specs HOT 6
- Issues with API registration HOT 3
- bug: celery app does not have access to database config
- Pin importlib-metadata version HOT 2
- Fix API docs
- Cannot use foca with empty database HOT 4
- build: add py3.11 support; use Debian 11 HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from foca.